| Package | hl7.cda.us.ccda |
| Type | StructureDefinition |
| Id | Id |
| FHIR Version | R5 |
| Source | http://hl7.org/cda/us/ccda/https://build.fhir.org/ig/HL7/CDA-ccda/StructureDefinition-UnstructuredDocument.html |
| Url | http://hl7.org/cda/us/ccda/StructureDefinition/UnstructuredDocument |
| Version | 4.0.0-ballot |
| Status | active |
| Date | 2024-12-11T22:59:59+00:00 |
| Name | UnstructuredDocument |
| Title | Unstructured Document |
| Experimental | False |
| Realm | us |
| Authority | hl7 |
| Description | An Unstructured Document (UD) document type can (1) include unstructured content, such as a graphic, directly in a text element with a mediaType attribute, or (2) reference a single document file, such as a word-processing document using a text/reference element. For guidance on how to handle multiple files, on the selection of media types for this IG, and on the identification of external files, see the examples that follow the constraints below. IHEs XDS-SD (Cross-Transaction Specifications and Content Specifications, Scanned Documents Module) profile addresses a similar, more restricted use case, specifically for scanned documents or documents electronically created from existing text sources, and limits content to PDF-A or text. This Unstructured Documents template is applicable not only for scanned documents in non-PDF formats, but also for clinical documents produced through word processing applications, etc. For conformance with both specifications, implementers need to ensure that their documents at a minimum conform with the SHALL constraints from either specification. |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument |
| Kind | logical |
No resources found
| StructureDefinition | |
USRealmHeader  | US Realm Header |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition UnstructuredDocument
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ClinicalDocument | 1..1 | USRealmHeader | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, @classCode, @moodCode, realmCode, typeId, templateId, id, sdtcCategory, code, title, sdtcStatusCode, effectiveTime, confidentialityCode, languageCode, setId, versionNumber, copyTime, recordTarget, author, dataEnterer, informant, custodian, informationRecipient, legalAuthenticator, authenticator, participant, inFulfillmentOf, documentationOf, relatedDocument, authorization, componentOf, component, realmCode, typeId, templateId, templateId, id, code, title, effectiveTime, languageCode, setId, versionNumber, recordTarget, author, dataEnterer, informant, informant, informant, custodian, informationRecipient, legalAuthenticator, authenticator, participant, inFulfillmentOf, documentationOf, authorization, componentOf Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | |
 templateId | 2..* | II | ||
 Slices for templateId | Content/Rules for all slices | |||
   templateId:unstructured-doc | 1..1 | II | ||
  @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.1.10 | |
  @extension | 1..1 | st | Required Pattern: 2024-05-01 | |
| recordTarget | 1..* | RecordTarget | The recordTarget records the administrative and demographic data of the patient whose health information is described by the clinical document; each recordTarget must contain at least one patientRole element | |
 patientRole | 1..1 | PatientRole | ||
| id | 1..* | II | ||
| custodian | 1..1 | Custodian | The custodian element represents the organization that is in charge of maintaining and is entrusted with the care of the document. There is only one custodian per CDA document. Allowing that a CDA document may not represent the original form of the authenticated document, the custodian represents the steward of the original source document. The custodian may be the document originator, a health information exchange, or other responsible party. | |
| assignedCustodian | 1..1 | AssignedCustodian | ||
| representedCustodianOrganization | 1..1 | CustodianOrganization | ||
| component | 1..1 | Component | ||
| nonXMLBody | 1..1 | NonXMLBody | An Unstructured Document must include a nonXMLBody component with a single text element. The text element can reference an external file using a reference element, or include unstructured content directly with a mediaType attribute. The nonXMLBody/text element also has a "compression" attribute that can be used to indicate that the unstructured content was compressed before being Base64Encoded. At a minimum, a compression value of "DF" for the deflate compression algorithm (RFC 1951 [URL:http://www.ietf.org/rfc/rfc1951.txt]) must be supported although it is not required that content be compressed. | |
| text | C | 1..1 | ED | 1198-7624: If the text element does not contain a reference element with a value attribute, then it **SHALL** contain exactly one [1..1] @representation="B64" and exactly one [1..1] @mediaType (CONF:1198-7624). |
| @mediaType | 0..1 | cs | Binding: SupportedFileFormats  (required) | |
| Documentation for this format | ||||
FHIR{
"resourceType" : "StructureDefinition",
"id" : "UnstructuredDocument",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: StructureDefinition UnstructuredDocument</b></p><a name=\"UnstructuredDocument\"> </a><a name=\"hcUnstructuredDocument\"> </a><a name=\"UnstructuredDocument-en-US\"> </a><table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;\"><tr style=\"border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top\"><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"The logical name of the element\">Name</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Information about the use of the element\">Flags</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Minimum and Maximum # of times the element can appear in the instance\">Card.</a></th><th style=\"width: 100px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Reference to the type of the element\">Type</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Additional information about the element\">Description & Constraints</a><span style=\"float: right\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Legend for this format\"><img src=\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC\" alt=\"doco\" style=\"background-color: inherit\"/></a></span></th></tr><tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-UnstructuredDocument-definitions.html#ClinicalDocument\">ClinicalDocument</a><a name=\"ClinicalDocument\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">1</span><span style=\"opacity: 0.5\">..</span><span style=\"opacity: 0.5\">1</span></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"StructureDefinition-USRealmHeader.html\">USRealmHeader</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"font-weight:bold\">XML Namespace: </span>urn:hl7-org:v3<br/>Elements defined in Ancestors:<a href=\"https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-ANY.html\" title=\"If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.\">@nullFlavor</a>, <a href=\"https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-ClinicalDocument.html\">@classCode</a>, <a href=\"https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-ClinicalDocument.html\">@moodCode</a>, <a href=\"https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-ClinicalDocument.html\" title=\"When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question\">realmCode</a>, <a href=\"https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-ClinicalDocument.html\" title=\"ClinicalDocument.typeId is a technology-neutral explicit reference to this CDA, Release Two specification, and must be valued as follows: ClinicalDocument.typeId.root = "2.16.840.1.113883.1.3" (which is the OID for HL7 Registered models); ClinicalDocument.typeId.extension = "POCD_HD000040" (which is the unique identifier for the CDA, Release Two Hierarchical Description).\">typeId</a>, <a href=\"https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-ClinicalDocument.html\" title=\"When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question\">templateId</a>, <a href=\"https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-ClinicalDocument.html\">id</a>, <a href=\"https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-ClinicalDocument.html\">sdtcCategory</a>, <a href=\"https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-ClinicalDocument.html\">code</a>, <a href=\"https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-ClinicalDocument.html\">title</a>, <a href=\"https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-ClinicalDocument.html\" title=\"The statusCode extension attribute allows the implementer to identify a ClinicalDocument that is in other than the completed state. It was created to support the Structured Form Definition IG to identify that the document itself is an unfinished product currently being completed for a patient.\">sdtcStatusCode</a>, <a href=\"https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-ClinicalDocument.html\">effectiveTime</a>, <a href=\"https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-ClinicalDocument.html\">confidentialityCode</a>, <a href=\"https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-ClinicalDocument.html\">languageCode</a>, <a href=\"https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-ClinicalDocument.html\">setId</a>, <a href=\"https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-ClinicalDocument.html\">versionNumber</a>, <a href=\"https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-ClinicalDocument.html\">copyTime</a>, <a href=\"https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-ClinicalDocument.html\">recordTarget</a>, <a href=\"https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-ClinicalDocument.html\">author</a>, <a href=\"https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-ClinicalDocument.html\">dataEnterer</a>, <a href=\"https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-ClinicalDocument.html\">informant</a>, <a href=\"https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-ClinicalDocument.html\">custodian</a>, <a href=\"https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-ClinicalDocument.html\">informationRecipient</a>, <a href=\"https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-ClinicalDocument.html\">legalAuthenticator</a>, <a href=\"https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-ClinicalDocument.html\">authenticator</a>, <a href=\"https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-ClinicalDocument.html\">participant</a>, <a href=\"https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-ClinicalDocument.html\">inFulfillmentOf</a>, <a href=\"https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-ClinicalDocument.html\">documentationOf</a>, <a href=\"https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-ClinicalDocument.html\">relatedDocument</a>, <a href=\"https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-ClinicalDocument.html\">authorization</a>, <a href=\"https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-ClinicalDocument.html\">componentOf</a>, <a href=\"https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-ClinicalDocument.html\">component</a>, <a href=\"StructureDefinition-USRealmHeader.html\">realmCode</a>, <a href=\"StructureDefinition-USRealmHeader.html\">typeId</a>, <a href=\"StructureDefinition-USRealmHeader.html\">templateId</a>, <a href=\"StructureDefinition-USRealmHeader.html\">templateId</a>, <a href=\"StructureDefinition-USRealmHeader.html\">id</a>, <a href=\"StructureDefinition-USRealmHeader.html\">code</a>, <a href=\"StructureDefinition-USRealmHeader.html\">title</a>, <a href=\"StructureDefinition-USRealmHeader.html\">effectiveTime</a>, <a href=\"StructureDefinition-USRealmHeader.html\">languageCode</a>, <a href=\"StructureDefinition-USRealmHeader.html\">setId</a>, <a href=\"StructureDefinition-USRealmHeader.html\">versionNumber</a>, <a href=\"StructureDefinition-USRealmHeader.html\">recordTarget</a>, <a href=\"StructureDefinition-USRealmHeader.html\">author</a>, <a href=\"StructureDefinition-USRealmHeader.html\">dataEnterer</a>, <a href=\"StructureDefinition-USRealmHeader.html\">informant</a>, <a href=\"StructureDefinition-USRealmHeader.html\">informant</a>, <a href=\"StructureDefinition-USRealmHeader.html\">informant</a>, <a href=\"StructureDefinition-USRealmHeader.html\">custodian</a>, <a href=\"StructureDefinition-USRealmHeader.html\">informationRecipient</a>, <a href=\"StructureDefinition-USRealmHeader.html\">legalAuthenticator</a>, <a href=\"StructureDefinition-USRealmHeader.html\">authenticator</a>, <a href=\"StructureDefinition-USRealmHeader.html\">participant</a>, <a href=\"StructureDefinition-USRealmHeader.html\">inFulfillmentOf</a>, <a href=\"StructureDefinition-USRealmHeader.html\">documentationOf</a>, <a href=\"StructureDefinition-USRealmHeader.html\">authorization</a>, <a href=\"StructureDefinition-USRealmHeader.html\">componentOf</a><br/><span style=\"opacity: 0.5\">Base for all types and resources</span><br/><span style=\"font-weight:bold\">Instance of this type are validated by templateId</span><br/><span style=\"font-weight:bold\" title=\"The root class that contains instances of this class\">Logical Container: </span><a href=\"https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-ClinicalDocument.html\">ClinicalDocument (CDA Class)</a></td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-UnstructuredDocument-definitions.html#ClinicalDocument.templateId\">templateId</a><a name=\"ClinicalDocument.templateId\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">2..<span style=\"opacity: 0.5\">*</span></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"opacity: 0.5\" href=\"https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-II.html\">II</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck13.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_slice.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Slice Definition\" class=\"hierarchy\"/> Slices for templateId<a name=\"ClinicalDocument.templateId.2\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Content/Rules for all slices</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck125.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end_slicer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_slice_item.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Slice Item\" class=\"hierarchy\"/> <a href=\"StructureDefinition-UnstructuredDocument-definitions.html#ClinicalDocument.templateId:unstructured-doc\" title=\"Slice unstructured-doc\">templateId:unstructured-doc</a><a name=\"ClinicalDocument.templateId.3\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"opacity: 0.5\" href=\"https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-II.html\">II</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1250.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_blank.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_slice.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-UnstructuredDocument-definitions.html#ClinicalDocument.templateId:unstructured-doc.root\">@root</a><a name=\"ClinicalDocument.templateId.root\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..<span style=\"opacity: 0.5\">1</span></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"opacity: 0.5\" href=\"https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-oid.html\" title=\"string\">oid</a><span style=\"opacity: 0.5\">, </span><a style=\"opacity: 0.5\" href=\"https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-uuid.html\" title=\"string\">uuid</a><span style=\"opacity: 0.5\">, </span><a style=\"opacity: 0.5\" href=\"https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-ruid.html\" title=\"string\">ruid</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"font-weight:bold\">Required Pattern: </span><span style=\"color: darkgreen\">2.16.840.1.113883.10.20.22.1.10</span></td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1240.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_blank.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end_slice.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_extension_simple.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Simple Extension\" class=\"hierarchy\"/> <a href=\"StructureDefinition-UnstructuredDocument-definitions.html#ClinicalDocument.templateId:unstructured-doc.extension\">@extension</a><a name=\"ClinicalDocument.templateId.extension\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..<span style=\"opacity: 0.5\">1</span></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"opacity: 0.5\" href=\"https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-st-simple.html\" title=\"string\">st</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"font-weight:bold\">Required Pattern: </span><span style=\"color: darkgreen\">2024-05-01</span></td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck11.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-UnstructuredDocument-definitions.html#ClinicalDocument.recordTarget\">recordTarget</a><a name=\"ClinicalDocument.recordTarget\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">1</span><span style=\"opacity: 0.5\">..</span><span style=\"opacity: 0.5\">*</span></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"opacity: 0.5\" href=\"https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-RecordTarget.html\">RecordTarget</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">The recordTarget records the administrative and demographic data of the patient whose health information is described by the clinical document; each recordTarget must contain at least one patientRole element</span></td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck101.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-UnstructuredDocument-definitions.html#ClinicalDocument.recordTarget.patientRole\">patientRole</a><a name=\"ClinicalDocument.recordTarget.patientRole\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">1</span><span style=\"opacity: 0.5\">..</span><span style=\"opacity: 0.5\">1</span></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"opacity: 0.5\" href=\"https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-PatientRole.html\">PatientRole</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1000.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_blank.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-UnstructuredDocument-definitions.html#ClinicalDocument.recordTarget.patientRole.id\">id</a><a name=\"ClinicalDocument.recordTarget.patientRole.id\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">1</span><span style=\"opacity: 0.5\">..</span><span style=\"opacity: 0.5\">*</span></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"opacity: 0.5\" href=\"https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-II.html\">II</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck11.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-UnstructuredDocument-definitions.html#ClinicalDocument.custodian\">custodian</a><a name=\"ClinicalDocument.custodian\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">1</span><span style=\"opacity: 0.5\">..</span><span style=\"opacity: 0.5\">1</span></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"opacity: 0.5\" href=\"https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-Custodian.html\">Custodian</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">The custodian element represents the organization that is in charge of maintaining and is entrusted with the care of the document.\n\n There is only one custodian per CDA document. Allowing that a CDA document may not represent the original form of the authenticated document, the custodian represents the steward of the original source document. The custodian may be the document originator, a health information exchange, or other responsible party.</span></td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck101.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-UnstructuredDocument-definitions.html#ClinicalDocument.custodian.assignedCustodian\">assignedCustodian</a><a name=\"ClinicalDocument.custodian.assignedCustodian\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">1</span><span style=\"opacity: 0.5\">..</span><span style=\"opacity: 0.5\">1</span></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"opacity: 0.5\" href=\"https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-AssignedCustodian.html\">AssignedCustodian</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1000.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_blank.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-UnstructuredDocument-definitions.html#ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization\">representedCustodianOrganization</a><a name=\"ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">1</span><span style=\"opacity: 0.5\">..</span><span style=\"opacity: 0.5\">1</span></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"opacity: 0.5\" href=\"https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-CustodianOrganization.html\">CustodianOrganization</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck01.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-UnstructuredDocument-definitions.html#ClinicalDocument.component\">component</a><a name=\"ClinicalDocument.component\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">1</span><span style=\"opacity: 0.5\">..</span><span style=\"opacity: 0.5\">1</span></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"opacity: 0.5\" href=\"https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-Component.html\">Component</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck001.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_blank.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-UnstructuredDocument-definitions.html#ClinicalDocument.component.nonXMLBody\">nonXMLBody</a><a name=\"ClinicalDocument.component.nonXMLBody\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..<span style=\"opacity: 0.5\">1</span></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"opacity: 0.5\" href=\"https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-NonXMLBody.html\">NonXMLBody</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">An Unstructured Document must include a nonXMLBody component with a single text element. The text element can reference an external file using a reference element, or include unstructured content directly with a mediaType attribute. The nonXMLBody/text element also has a "compression" attribute that can be used to indicate that the unstructured content was compressed before being Base64Encoded. At a minimum, a compression value of "DF" for the deflate compression algorithm (RFC 1951 [URL:http://www.ietf.org/rfc/rfc1951.txt]) must be supported although it is not required that content be compressed.</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck0001.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_blank.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_blank.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-UnstructuredDocument-definitions.html#ClinicalDocument.component.nonXMLBody.text\">text</a><a name=\"ClinicalDocument.component.nonXMLBody.text\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;\" href=\"http://hl7.org/fhir/R5/conformance-rules.html#constraints\" title=\"This element has or is affected by constraints ( 1198-7624 )\">C</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">1</span><span style=\"opacity: 0.5\">..</span><span style=\"opacity: 0.5\">1</span></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"opacity: 0.5\" href=\"https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-ED.html\">ED</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"font-weight:bold\">1198-7624: </span>If the text element does not contain a reference element with a value attribute, then it **SHALL** contain exactly one [1..1] @representation="B64" and exactly one [1..1] @mediaType (CONF:1198-7624).</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck00000.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_blank.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_blank.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_blank.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-UnstructuredDocument-definitions.html#ClinicalDocument.component.nonXMLBody.text.mediaType\">@mediaType</a><a name=\"ClinicalDocument.component.nonXMLBody.text.mediaType\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">0</span><span style=\"opacity: 0.5\">..</span><span style=\"opacity: 0.5\">1</span></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"opacity: 0.5\" href=\"https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-cs-simple.html\" title=\"code\">cs</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"font-weight:bold\">Binding: </span><a href=\"https://vsac.nlm.nih.gov/valueset/2.16.840.1.113883.11.20.7.1/expansion\" title=\"http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.7.1\">SupportedFileFormats <img src=\"external.png\" alt=\".\"/></a> (<a href=\"http://hl7.org/fhir/R5/terminologies.html#required\" title=\"To be conformant, the concept in this element SHALL be from the specified value set.\">required</a>)</td></tr>\r\n<tr><td colspan=\"5\" class=\"hierarchy\"><br/><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Legend for this format\"><img src=\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC\" alt=\"doco\" style=\"background-color: inherit\"/> Documentation for this format</a></td></tr></table></div>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/logical-target",
"_valueBoolean" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
"valueCode" : "not-applicable"
}
]
}
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "urn:hl7-org:v3"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString" : "ClinicalDocument"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/type-profile-style",
"valueUri" : "cda"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/logical-container",
"valueUri" : "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"
}
],
"url" : "http://hl7.org/cda/us/ccda/StructureDefinition/UnstructuredDocument",
"identifier" : [
{
"system" : "urn:ietf:rfc:3986",
"value" : "urn:hl7ii:2.16.840.1.113883.10.20.22.1.10:2024-05-01"
}
],
"version" : "4.0.0-ballot",
"name" : "UnstructuredDocument",
"title" : "Unstructured Document",
"status" : "active",
"date" : "2024-12-11T22:59:59+00:00",
"publisher" : "Health Level Seven",
"contact" : [
{
"name" : "HL7 International - Structured Documents",
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/structure"
}
]
}
],
"description" : "An Unstructured Document (UD) document type can (1) include unstructured content, such as a graphic, directly in a text element with a mediaType attribute, or (2) reference a single document file, such as a word-processing document using a text/reference element.\n\nFor guidance on how to handle multiple files, on the selection of media types for this IG, and on the identification of external files, see the examples that follow the constraints below.\n\nIHEs XDS-SD (Cross-Transaction Specifications and Content Specifications, Scanned Documents Module) profile addresses a similar, more restricted use case, specifically for scanned documents or documents electronically created from existing text sources, and limits content to PDF-A or text. This Unstructured Documents template is applicable not only for scanned documents in non-PDF formats, but also for clinical documents produced through word processing applications, etc. \n\nFor conformance with both specifications, implementers need to ensure that their documents at a minimum conform with the SHALL constraints from either specification.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "US"
}
]
}
],
"fhirVersion" : "5.0.0",
"mapping" : [
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}
],
"kind" : "logical",
"abstract" : false,
"type" : "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument",
"baseDefinition" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"derivation" : "constraint",
"snapshot" : {
"element" : [
{
"id" : "ClinicalDocument",
"path" : "ClinicalDocument",
"short" : "Base for all types and resources",
"definition" : "Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Base",
"min" : 0,
"max" : "*"
},
"constraint" : [
{
"key" : "4537-6380",
"severity" : "error",
"human" : "If setId is present versionNumber **SHALL** be present (CONF:4537-6380).",
"expression" : "setId.exists() implies versionNumber.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
},
{
"key" : "4537-6387",
"severity" : "error",
"human" : "If versionNumber is present setId **SHALL** be present (CONF:4537-6387).",
"expression" : "versionNumber.exists() implies setId.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
},
{
"key" : "should-legalAuthenticator",
"severity" : "warning",
"human" : "SHOULD contain legalAuthenticator",
"expression" : "legalAuthenticator.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
},
{
"key" : "should-relatedParticipant",
"severity" : "warning",
"human" : "Documents SHOULD contain a RelatedPerson participant",
"expression" : "participant.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/RelatedPersonRelationshipAndNameParticipant').exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
}
],
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "ClinicalDocument.nullFlavor",
"path" : "ClinicalDocument.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.classCode",
"path" : "ClinicalDocument.classCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.classCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "DOCCLIN",
"binding" : {
"strength" : "example",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAActClass"
}
},
{
"id" : "ClinicalDocument.moodCode",
"path" : "ClinicalDocument.moodCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.moodCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "EVN",
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAActMood"
}
},
{
"id" : "ClinicalDocument.realmCode",
"path" : "ClinicalDocument.realmCode",
"definition" : "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question",
"comment" : "SHALL contain exactly one [1..1] realmCode=\"US\" (CONF:4537-16791).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.realmCode",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
]
},
{
"id" : "ClinicalDocument.realmCode.nullFlavor",
"path" : "ClinicalDocument.realmCode.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.realmCode.code",
"path" : "ClinicalDocument.realmCode.code",
"representation" : [
"xmlAttr"
],
"label" : "Code",
"definition" : "The plain code symbol defined by the code system. For example, \"784.0\" is the code symbol of the ICD-9 code \"784.0\" for headache.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CD.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"patternCode" : "US"
},
{
"id" : "ClinicalDocument.realmCode.codeSystem",
"path" : "ClinicalDocument.realmCode.codeSystem",
"representation" : [
"xmlAttr"
],
"label" : "Code System",
"definition" : "Specifies the code system that defines the code.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "CD.codeSystem",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/oid",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
]
},
{
"id" : "ClinicalDocument.realmCode.codeSystemName",
"path" : "ClinicalDocument.realmCode.codeSystemName",
"representation" : [
"xmlAttr"
],
"label" : "Code System Name",
"definition" : "The common name of the coding system.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "CD.codeSystemName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.realmCode.codeSystemVersion",
"path" : "ClinicalDocument.realmCode.codeSystemVersion",
"representation" : [
"xmlAttr"
],
"label" : "Code System Version",
"definition" : "If applicable, a version descriptor defined specifically for the given code system.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "CD.codeSystemVersion",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.realmCode.displayName",
"path" : "ClinicalDocument.realmCode.displayName",
"representation" : [
"xmlAttr"
],
"label" : "Display Name",
"definition" : "A name or title for the code, under which the sending system shows the code value to its users.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "CD.displayName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.realmCode.sdtcValueSet",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString" : "valueSet"
}
],
"path" : "ClinicalDocument.realmCode.sdtcValueSet",
"representation" : [
"xmlAttr"
],
"definition" : "The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.valueSet",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/oid"
]
}
]
},
{
"id" : "ClinicalDocument.realmCode.sdtcValueSetVersion",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString" : "valueSetVersion"
}
],
"path" : "ClinicalDocument.realmCode.sdtcValueSetVersion",
"representation" : [
"xmlAttr"
],
"definition" : "The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.sdtcValueSetVersion",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.realmCode.originalText",
"path" : "ClinicalDocument.realmCode.originalText",
"label" : "Original Text",
"definition" : "The text or phrase used as the basis for the coding.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "CD.originalText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ED"
}
]
},
{
"id" : "ClinicalDocument.realmCode.qualifier",
"path" : "ClinicalDocument.realmCode.qualifier",
"label" : "Qualifier",
"definition" : "Specifies additional codes that increase the specificity of the the primary code.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "CD.qualifier",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CR"
}
]
},
{
"id" : "ClinicalDocument.realmCode.translation",
"path" : "ClinicalDocument.realmCode.translation",
"representation" : [
"typeAttr"
],
"label" : "Translation",
"definition" : "A set of other concept descriptors that translate this concept descriptor into other code systems.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "CD.translation",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CD"
}
]
},
{
"id" : "ClinicalDocument.typeId",
"path" : "ClinicalDocument.typeId",
"definition" : "ClinicalDocument.typeId is a technology-neutral explicit reference to this CDA, Release Two specification, and must be valued as follows: ClinicalDocument.typeId.root = \"2.16.840.1.113883.1.3\" (which is the OID for HL7 Registered models); ClinicalDocument.typeId.extension = \"POCD_HD000040\" (which is the unique identifier for the CDA, Release Two Hierarchical Description).",
"comment" : "SHALL contain exactly one [1..1] typeId (CONF:4537-5361).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.typeId",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
],
"constraint" : [
{
"key" : "II-1",
"severity" : "error",
"human" : "An II instance must have either a root or an nullFlavor.",
"expression" : "root.exists() or nullFlavor.exists()",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"
}
]
},
{
"id" : "ClinicalDocument.typeId.nullFlavor",
"path" : "ClinicalDocument.typeId.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.typeId.assigningAuthorityName",
"representation" : [
"xmlAttr"
],
"label" : "Assigning Authority Name",
"definition" : "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.assigningAuthorityName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.typeId.displayable",
"path" : "ClinicalDocument.typeId.displayable",
"representation" : [
"xmlAttr"
],
"label" : "Displayable",
"definition" : "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.displayable",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id" : "ClinicalDocument.typeId.root",
"path" : "ClinicalDocument.typeId.root",
"representation" : [
"xmlAttr"
],
"label" : "Root",
"definition" : "Identifies the type as an HL7 Registered model",
"comment" : "This typeId SHALL contain exactly one [1..1] @root=\"2.16.840.1.113883.1.3\" (CONF:4537-5250).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.root",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/oid",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
],
"fixedString" : "2.16.840.1.113883.1.3"
},
{
"id" : "ClinicalDocument.typeId.extension",
"path" : "ClinicalDocument.typeId.extension",
"representation" : [
"xmlAttr"
],
"label" : "Extension",
"definition" : "A character string as a unique identifier within the scope of the identifier root.",
"comment" : "This typeId SHALL contain exactly one [1..1] @extension=\"POCD_HD000040\" (CONF:4537-5251).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.extension",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
],
"fixedString" : "POCD_HD000040"
},
{
"id" : "ClinicalDocument.templateId",
"path" : "ClinicalDocument.templateId",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "root"
},
{
"type" : "value",
"path" : "extension"
}
],
"rules" : "open"
},
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 2,
"max" : "*",
"base" : {
"path" : "ClinicalDocument.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.templateId:us-realm",
"path" : "ClinicalDocument.templateId",
"sliceName" : "us-realm",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.templateId:us-realm.nullFlavor",
"path" : "ClinicalDocument.templateId.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.templateId:us-realm.assigningAuthorityName",
"path" : "ClinicalDocument.templateId.assigningAuthorityName",
"representation" : [
"xmlAttr"
],
"label" : "Assigning Authority Name",
"definition" : "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.assigningAuthorityName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.templateId:us-realm.displayable",
"path" : "ClinicalDocument.templateId.displayable",
"representation" : [
"xmlAttr"
],
"label" : "Displayable",
"definition" : "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.displayable",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id" : "ClinicalDocument.templateId:us-realm.root",
"path" : "ClinicalDocument.templateId.root",
"representation" : [
"xmlAttr"
],
"label" : "Root",
"definition" : "A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.root",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/oid",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
],
"patternString" : "2.16.840.1.113883.10.20.22.1.1"
},
{
"id" : "ClinicalDocument.templateId:us-realm.extension",
"path" : "ClinicalDocument.templateId.extension",
"representation" : [
"xmlAttr"
],
"label" : "Extension",
"definition" : "A character string as a unique identifier within the scope of the identifier root.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.extension",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
],
"patternString" : "2024-05-01"
},
{
"id" : "ClinicalDocument.templateId:unstructured-doc",
"path" : "ClinicalDocument.templateId",
"sliceName" : "unstructured-doc",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.templateId:unstructured-doc.nullFlavor",
"path" : "ClinicalDocument.templateId.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.templateId:unstructured-doc.assigningAuthorityName",
"path" : "ClinicalDocument.templateId.assigningAuthorityName",
"representation" : [
"xmlAttr"
],
"label" : "Assigning Authority Name",
"definition" : "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.assigningAuthorityName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.templateId:unstructured-doc.displayable",
"path" : "ClinicalDocument.templateId.displayable",
"representation" : [
"xmlAttr"
],
"label" : "Displayable",
"definition" : "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.displayable",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id" : "ClinicalDocument.templateId:unstructured-doc.root",
"path" : "ClinicalDocument.templateId.root",
"representation" : [
"xmlAttr"
],
"label" : "Root",
"definition" : "A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.root",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/oid",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
],
"patternString" : "2.16.840.1.113883.10.20.22.1.10"
},
{
"id" : "ClinicalDocument.templateId:unstructured-doc.extension",
"path" : "ClinicalDocument.templateId.extension",
"representation" : [
"xmlAttr"
],
"label" : "Extension",
"definition" : "A character string as a unique identifier within the scope of the identifier root.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.extension",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
],
"patternString" : "2024-05-01"
},
{
"id" : "ClinicalDocument.id",
"path" : "ClinicalDocument.id",
"short" : "**SHALL** be a globally unique identifier for the document (CONF:4537-9991).",
"comment" : "SHALL contain exactly one [1..1] id (CONF:4537-5363).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.id",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.sdtcCategory",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString" : "category"
}
],
"path" : "ClinicalDocument.sdtcCategory",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClinicalDocument.sdtcCategory",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CD"
}
]
},
{
"id" : "ClinicalDocument.code",
"path" : "ClinicalDocument.code",
"short" : "**SHALL** specify the particular kind of document (e.g., History and Physical, Discharge Summary, Progress Note) (CONF:4537-9992).",
"comment" : "SHALL contain exactly one [1..1] code (CONF:4537-5253).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.code",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "example",
"valueSet" : "http://hl7.org/fhir/ValueSet/doc-typecodes"
}
},
{
"id" : "ClinicalDocument.code.nullFlavor",
"path" : "ClinicalDocument.code.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.code.code",
"path" : "ClinicalDocument.code.code",
"representation" : [
"xmlAttr"
],
"label" : "Code",
"definition" : "The plain code symbol defined by the code system. For example, \"784.0\" is the code symbol of the ICD-9 code \"784.0\" for headache.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CD.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.code.codeSystem",
"path" : "ClinicalDocument.code.codeSystem",
"representation" : [
"xmlAttr"
],
"label" : "Code System",
"definition" : "Specifies the code system that defines the code.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CD.codeSystem",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/oid",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
],
"patternString" : "2.16.840.1.113883.6.1"
},
{
"id" : "ClinicalDocument.code.codeSystemName",
"path" : "ClinicalDocument.code.codeSystemName",
"representation" : [
"xmlAttr"
],
"label" : "Code System Name",
"definition" : "The common name of the coding system.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.codeSystemName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.code.codeSystemVersion",
"path" : "ClinicalDocument.code.codeSystemVersion",
"representation" : [
"xmlAttr"
],
"label" : "Code System Version",
"definition" : "If applicable, a version descriptor defined specifically for the given code system.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.codeSystemVersion",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.code.displayName",
"path" : "ClinicalDocument.code.displayName",
"representation" : [
"xmlAttr"
],
"label" : "Display Name",
"definition" : "A name or title for the code, under which the sending system shows the code value to its users.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.displayName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.code.sdtcValueSet",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString" : "valueSet"
}
],
"path" : "ClinicalDocument.code.sdtcValueSet",
"representation" : [
"xmlAttr"
],
"definition" : "The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.valueSet",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/oid"
]
}
]
},
{
"id" : "ClinicalDocument.code.sdtcValueSetVersion",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString" : "valueSetVersion"
}
],
"path" : "ClinicalDocument.code.sdtcValueSetVersion",
"representation" : [
"xmlAttr"
],
"definition" : "The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.sdtcValueSetVersion",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.code.originalText",
"path" : "ClinicalDocument.code.originalText",
"label" : "Original Text",
"definition" : "The text or phrase used as the basis for the coding.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.originalText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ED"
}
]
},
{
"id" : "ClinicalDocument.code.qualifier",
"path" : "ClinicalDocument.code.qualifier",
"label" : "Qualifier",
"definition" : "Specifies additional codes that increase the specificity of the the primary code.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "CD.qualifier",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CR"
}
]
},
{
"id" : "ClinicalDocument.code.translation",
"path" : "ClinicalDocument.code.translation",
"representation" : [
"typeAttr"
],
"label" : "Translation",
"definition" : "A set of other concept descriptors that translate this concept descriptor into other code systems.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CD.translation",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CD"
}
]
},
{
"id" : "ClinicalDocument.title",
"path" : "ClinicalDocument.title",
"short" : "The title can either be a locally defined name or the displayName corresponding to clinicalDocument/code",
"comment" : "SHALL contain exactly one [1..1] title (CONF:4537-5254).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.title",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.sdtcStatusCode",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString" : "statusCode"
}
],
"path" : "ClinicalDocument.sdtcStatusCode",
"definition" : "The statusCode extension attribute allows the implementer to identify a ClinicalDocument that is in other than the completed state. It was created to support the Structured Form Definition IG to identify that the document itself is an unfinished product currently being completed for a patient.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.sdtcStatusCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActStatus"
}
},
{
"id" : "ClinicalDocument.effectiveTime",
"path" : "ClinicalDocument.effectiveTime",
"short" : "Base for all types and resources",
"definition" : "A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.",
"comment" : "SHALL contain exactly one [1..1] US Realm Date and Time (Point in Time) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5256).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.effectiveTime",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/TS",
"profile" : [
"http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTime"
]
}
],
"constraint" : [
{
"key" : "ts-shall-day",
"severity" : "error",
"human" : "**SHALL** be precise to at least the day",
"expression" : "nullFlavor.exists() or value.toString().length() >= 10",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTime"
},
{
"key" : "ts-should-minute",
"severity" : "warning",
"human" : "**SHOULD** be precise to at least the minute",
"expression" : "nullFlavor.exists() or value.toString().length() > 10",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTime"
}
],
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "ClinicalDocument.confidentialityCode",
"path" : "ClinicalDocument.confidentialityCode",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.confidentialityCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
]
},
{
"id" : "ClinicalDocument.confidentialityCode.nullFlavor",
"path" : "ClinicalDocument.confidentialityCode.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.confidentialityCode.code",
"path" : "ClinicalDocument.confidentialityCode.code",
"representation" : [
"xmlAttr"
],
"label" : "Code",
"definition" : "The plain code symbol defined by the code system. For example, \"784.0\" is the code symbol of the ICD-9 code \"784.0\" for headache.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CD.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "preferred",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.16926"
}
},
{
"id" : "ClinicalDocument.confidentialityCode.codeSystem",
"path" : "ClinicalDocument.confidentialityCode.codeSystem",
"representation" : [
"xmlAttr"
],
"label" : "Code System",
"definition" : "Specifies the code system that defines the code.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.codeSystem",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/oid",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
]
},
{
"id" : "ClinicalDocument.confidentialityCode.codeSystemName",
"path" : "ClinicalDocument.confidentialityCode.codeSystemName",
"representation" : [
"xmlAttr"
],
"label" : "Code System Name",
"definition" : "The common name of the coding system.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.codeSystemName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.confidentialityCode.codeSystemVersion",
"path" : "ClinicalDocument.confidentialityCode.codeSystemVersion",
"representation" : [
"xmlAttr"
],
"label" : "Code System Version",
"definition" : "If applicable, a version descriptor defined specifically for the given code system.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.codeSystemVersion",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.confidentialityCode.displayName",
"path" : "ClinicalDocument.confidentialityCode.displayName",
"representation" : [
"xmlAttr"
],
"label" : "Display Name",
"definition" : "A name or title for the code, under which the sending system shows the code value to its users.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.displayName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.confidentialityCode.sdtcValueSet",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString" : "valueSet"
}
],
"path" : "ClinicalDocument.confidentialityCode.sdtcValueSet",
"representation" : [
"xmlAttr"
],
"definition" : "The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.valueSet",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/oid"
]
}
]
},
{
"id" : "ClinicalDocument.confidentialityCode.sdtcValueSetVersion",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString" : "valueSetVersion"
}
],
"path" : "ClinicalDocument.confidentialityCode.sdtcValueSetVersion",
"representation" : [
"xmlAttr"
],
"definition" : "The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.sdtcValueSetVersion",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.confidentialityCode.originalText",
"path" : "ClinicalDocument.confidentialityCode.originalText",
"label" : "Original Text",
"definition" : "The text or phrase used as the basis for the coding.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.originalText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ED"
}
]
},
{
"id" : "ClinicalDocument.confidentialityCode.qualifier",
"path" : "ClinicalDocument.confidentialityCode.qualifier",
"label" : "Qualifier",
"definition" : "Specifies additional codes that increase the specificity of the the primary code.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "CD.qualifier",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CR"
}
]
},
{
"id" : "ClinicalDocument.confidentialityCode.translation",
"path" : "ClinicalDocument.confidentialityCode.translation",
"representation" : [
"typeAttr"
],
"label" : "Translation",
"definition" : "A set of other concept descriptors that translate this concept descriptor into other code systems.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CD.translation",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CD"
}
]
},
{
"id" : "ClinicalDocument.languageCode",
"path" : "ClinicalDocument.languageCode",
"comment" : "SHALL contain exactly one [1..1] languageCode, which SHALL be selected from ValueSet AllLanguages https://www.hl7.org/fhir/valueset-all-languages.html (OID 2.16.840.1.113883.4.642.3.21) DYNAMIC.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.languageCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/fhir/ValueSet/all-languages"
}
},
{
"id" : "ClinicalDocument.setId",
"path" : "ClinicalDocument.setId",
"comment" : "MAY contain zero or one [0..1] setId (CONF:4537-5261).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.setId",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.versionNumber",
"path" : "ClinicalDocument.versionNumber",
"comment" : "MAY contain zero or one [0..1] versionNumber (CONF:4537-5264).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.versionNumber",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/INT"
}
]
},
{
"id" : "ClinicalDocument.copyTime",
"path" : "ClinicalDocument.copyTime",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.copyTime",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/TS"
}
]
},
{
"id" : "ClinicalDocument.recordTarget",
"path" : "ClinicalDocument.recordTarget",
"short" : "The recordTarget records the administrative and demographic data of the patient whose health information is described by the clinical document; each recordTarget must contain at least one patientRole element",
"comment" : "SHALL contain at least one [1..*] recordTarget (CONF:1198-31089).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "ClinicalDocument.recordTarget",
"min" : 1,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/RecordTarget"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.nullFlavor",
"path" : "ClinicalDocument.recordTarget.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.recordTarget.realmCode",
"path" : "ClinicalDocument.recordTarget.realmCode",
"definition" : "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "InfrastructureRoot.realmCode",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.typeId",
"path" : "ClinicalDocument.recordTarget.typeId",
"definition" : "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "InfrastructureRoot.typeId",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
],
"constraint" : [
{
"key" : "II-1",
"severity" : "error",
"human" : "An II instance must have either a root or an nullFlavor.",
"expression" : "root.exists() or nullFlavor.exists()",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.typeId.nullFlavor",
"path" : "ClinicalDocument.recordTarget.typeId.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.recordTarget.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.recordTarget.typeId.assigningAuthorityName",
"representation" : [
"xmlAttr"
],
"label" : "Assigning Authority Name",
"definition" : "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.assigningAuthorityName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.typeId.displayable",
"path" : "ClinicalDocument.recordTarget.typeId.displayable",
"representation" : [
"xmlAttr"
],
"label" : "Displayable",
"definition" : "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.displayable",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.typeId.root",
"path" : "ClinicalDocument.recordTarget.typeId.root",
"representation" : [
"xmlAttr"
],
"label" : "Root",
"definition" : "Identifies the type as an HL7 Registered model",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.root",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/oid",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
],
"fixedString" : "2.16.840.1.113883.1.3"
},
{
"id" : "ClinicalDocument.recordTarget.typeId.extension",
"path" : "ClinicalDocument.recordTarget.typeId.extension",
"representation" : [
"xmlAttr"
],
"label" : "Extension",
"definition" : "A character string as a unique identifier within the scope of the identifier root.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.extension",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.templateId",
"path" : "ClinicalDocument.recordTarget.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "InfrastructureRoot.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.typeCode",
"path" : "ClinicalDocument.recordTarget.typeCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "RecordTarget.typeCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "RCT",
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType"
}
},
{
"id" : "ClinicalDocument.recordTarget.contextControlCode",
"path" : "ClinicalDocument.recordTarget.contextControlCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "RecordTarget.contextControlCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "OP",
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAContextControl"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole",
"path" : "ClinicalDocument.recordTarget.patientRole",
"comment" : "Such recordTargets SHALL contain exactly one [1..1] patientRole (CONF:1198-31090).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "RecordTarget.patientRole",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/PatientRole"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.realmCode",
"path" : "ClinicalDocument.recordTarget.patientRole.realmCode",
"definition" : "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "InfrastructureRoot.realmCode",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.typeId",
"path" : "ClinicalDocument.recordTarget.patientRole.typeId",
"definition" : "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "InfrastructureRoot.typeId",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
],
"constraint" : [
{
"key" : "II-1",
"severity" : "error",
"human" : "An II instance must have either a root or an nullFlavor.",
"expression" : "root.exists() or nullFlavor.exists()",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.typeId.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.typeId.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.recordTarget.patientRole.typeId.assigningAuthorityName",
"representation" : [
"xmlAttr"
],
"label" : "Assigning Authority Name",
"definition" : "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.assigningAuthorityName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.typeId.displayable",
"path" : "ClinicalDocument.recordTarget.patientRole.typeId.displayable",
"representation" : [
"xmlAttr"
],
"label" : "Displayable",
"definition" : "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.displayable",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.typeId.root",
"path" : "ClinicalDocument.recordTarget.patientRole.typeId.root",
"representation" : [
"xmlAttr"
],
"label" : "Root",
"definition" : "Identifies the type as an HL7 Registered model",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.root",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/oid",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
],
"fixedString" : "2.16.840.1.113883.1.3"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.typeId.extension",
"path" : "ClinicalDocument.recordTarget.patientRole.typeId.extension",
"representation" : [
"xmlAttr"
],
"label" : "Extension",
"definition" : "A character string as a unique identifier within the scope of the identifier root.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.extension",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.templateId",
"path" : "ClinicalDocument.recordTarget.patientRole.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "InfrastructureRoot.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.classCode",
"path" : "ClinicalDocument.recordTarget.patientRole.classCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "PatientRole.classCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "PAT",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-RoleClassRelationshipFormal"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.id",
"path" : "ClinicalDocument.recordTarget.patientRole.id",
"comment" : "This patientRole SHALL contain at least one [1..*] id (CONF:1198-31091).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "PatientRole.id",
"min" : 1,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.sdtcIdentifiedBy",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString" : "identifiedBy"
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.sdtcIdentifiedBy",
"min" : 0,
"max" : "*",
"base" : {
"path" : "PatientRole.sdtcIdentifiedBy",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.addr",
"extension" : [
{
"url" : "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement",
"valueBoolean" : true
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.addr",
"short" : "ð—¨ð—¦ð—–ð——ð—œ: Address",
"definition" : "Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.",
"comment" : "This patientRole SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5271).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "PatientRole.addr",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/AD",
"profile" : [
"http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
]
}
],
"constraint" : [
{
"key" : "shall-city",
"severity" : "error",
"human" : "SHALL contain exactly one [1..1] city (CONF:81-7292).",
"expression" : "nullFlavor.exists() or item.city.count() = 1",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "shall-streetAddressLine",
"severity" : "error",
"human" : "SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291).",
"expression" : "nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4)",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "should-use",
"severity" : "warning",
"human" : "SHOULD contain @use",
"expression" : "nullFlavor.exists() or use.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "should-country",
"severity" : "warning",
"human" : "SHOULD contain country",
"expression" : "nullFlavor.exists() or item.country.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "81-7296",
"severity" : "error",
"human" : "**SHALL NOT** have mixed content except for white space (CONF:81-7296)",
"expression" : "item.xmlText.empty()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "81-10024",
"severity" : "error",
"human" : "If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024).",
"expression" : "nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state'))",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "81-10025",
"severity" : "error",
"human" : "If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).",
"expression" : "nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?'))",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "shall-max-ad-parts",
"severity" : "error",
"human" : "SHALL have at most one of each: state, city, postalCode, and country",
"expression" : "(item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1)",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
}
],
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.telecom",
"extension" : [
{
"url" : "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement",
"valueBoolean" : true
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.telecom",
"short" : "ð—¨ð—¦ð—–ð——ð—œ: Phone Number / Email",
"min" : 1,
"max" : "*",
"base" : {
"path" : "PatientRole.telecom",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/TEL"
}
],
"constraint" : [
{
"key" : "should-use",
"severity" : "warning",
"human" : "SHOULD contain @use",
"expression" : "nullFlavor.exists() or use.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.telecom.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.telecom.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.telecom.value",
"path" : "ClinicalDocument.recordTarget.patientRole.telecom.value",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "TEL.value",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "url",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/url"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.telecom.useablePeriod",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-defaulttype",
"valueCanonical" : "http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS"
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.telecom.useablePeriod",
"representation" : [
"typeAttr"
],
"label" : "Useable Period",
"definition" : "Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "TEL.useablePeriod",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"
},
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS"
},
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS"
},
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.telecom.use",
"path" : "ClinicalDocument.recordTarget.patientRole.telecom.use",
"representation" : [
"xmlAttr"
],
"label" : "Use Code",
"definition" : "One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.",
"comment" : "Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-5375).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TEL.use",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient",
"path" : "ClinicalDocument.recordTarget.patientRole.patient",
"comment" : "This patientRole SHALL contain exactly one [1..1] patient (CONF:4537-5283).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "PatientRole.patient",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Patient"
}
],
"constraint" : [
{
"key" : "4537-32993",
"severity" : "error",
"human" : "If sdtc:deceasedInd=\"true\", then sdtc:deceasedTime **SHALL** be present with either a @value or @nullFlavor=UNK (CONF:4537-32993).",
"expression" : "sdtcDeceasedInd.exists(value='true') implies sdtcDeceasedTime.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
},
{
"key" : "4537-21000",
"severity" : "error",
"human" : "If sdtc:deceasedTime/@value is present, then sdtc:deceasedInd SHALL be present with value=true",
"expression" : "sdtcDeceasedTime.value.exists() implies sdtcDeceasedInd.exists(value='true')",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
},
{
"key" : "should-maritalStatusCode",
"severity" : "warning",
"human" : "SHOULD contain maritalStatusCode",
"expression" : "maritalStatusCode.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
},
{
"key" : "should-us-languageCommunication",
"severity" : "warning",
"human" : "SHOULD contain languageCommunication",
"expression" : "languageCommunication.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.realmCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.realmCode",
"definition" : "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "InfrastructureRoot.realmCode",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.typeId",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.typeId",
"definition" : "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "InfrastructureRoot.typeId",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
],
"constraint" : [
{
"key" : "II-1",
"severity" : "error",
"human" : "An II instance must have either a root or an nullFlavor.",
"expression" : "root.exists() or nullFlavor.exists()",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.typeId.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.typeId.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.typeId.assigningAuthorityName",
"representation" : [
"xmlAttr"
],
"label" : "Assigning Authority Name",
"definition" : "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.assigningAuthorityName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.typeId.displayable",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.typeId.displayable",
"representation" : [
"xmlAttr"
],
"label" : "Displayable",
"definition" : "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.displayable",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.typeId.root",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.typeId.root",
"representation" : [
"xmlAttr"
],
"label" : "Root",
"definition" : "Identifies the type as an HL7 Registered model",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.root",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/oid",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
],
"fixedString" : "2.16.840.1.113883.1.3"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.typeId.extension",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.typeId.extension",
"representation" : [
"xmlAttr"
],
"label" : "Extension",
"definition" : "A character string as a unique identifier within the scope of the identifier root.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.extension",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.templateId",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "InfrastructureRoot.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.classCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.classCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.classCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "PSN",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.determinerCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.determinerCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.determinerCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "INSTANCE",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityDeterminer"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.id",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.id",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.name",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.name",
"short" : "Base for all types and resources",
"definition" : "A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are \"Jim Bob Walton, Jr.\", \"Adam Everyman\", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, \"Jim\", \"Bob\", \"Walton\", and \"Jr.\". PN differs from EN because the qualifier type cannot include LS (Legal Status).",
"comment" : "This patient SHALL contain at least one [1..*] US Realm Patient Name (PTN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1) (CONF:4537-5284).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "Patient.name",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/PN",
"profile" : [
"http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED"
]
}
],
"constraint" : [
{
"key" : "pn-no-ls",
"severity" : "error",
"human" : "No PN name part may have a qualifier of LS.",
"expression" : "(item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty()",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/PN"
},
{
"key" : "shall-family",
"severity" : "error",
"human" : "SHALL contain exactly one [1..1] family (CONF:81-7159).",
"expression" : "nullFlavor.exists() or item.family.count() = 1",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED"
},
{
"key" : "shall-given",
"severity" : "error",
"human" : "SHALL contain at least one [1..*] given (CONF:81-7157).",
"expression" : "nullFlavor.exists() or item.given.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED"
},
{
"key" : "shall-max-suffix",
"severity" : "error",
"human" : "There may be at most one suffix",
"expression" : "(item.suffix.empty() or item.suffix.count() = 1)",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED"
},
{
"key" : "81-7278",
"severity" : "error",
"human" : "**SHALL NOT** have mixed content except for white space (CONF:81-7278).",
"expression" : "item.xmlText.empty()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED"
}
],
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.sdtcDesc",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString" : "desc"
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.patient.sdtcDesc",
"definition" : "The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.sdtcDesc",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ED"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.administrativeGenderCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.administrativeGenderCode",
"comment" : "This patient SHALL contain exactly one [1..1] administrativeGenderCode, which SHALL be selected from ValueSet Administrative Gender (HL7 V3) urn:oid:2.16.840.1.113883.1.11.1 DYNAMIC (CONF:4537-6394).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Patient.administrativeGenderCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.1"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthTime",
"extension" : [
{
"url" : "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement",
"valueBoolean" : true
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthTime",
"short" : "ð—¨ð—¦ð—–ð——ð—œ: Date of Birth - **MAY** be precise to the minute (CONF:4537-32418) (For cases where information about newborn's time of birth needs to be captured)",
"comment" : "This patient SHALL contain exactly one [1..1] birthTime (CONF:4537-5298).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Patient.birthTime",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/TS"
}
],
"constraint" : [
{
"key" : "ts-shall-year",
"severity" : "error",
"human" : "**SHALL** be precise to at least the year",
"expression" : "nullFlavor.exists() or value.toString().length() >= 4",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
},
{
"key" : "ts-should-day",
"severity" : "warning",
"human" : "**SHOULD** be precise to at least the day",
"expression" : "nullFlavor.exists() or value.toString().length() >= 10",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedInd",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString" : "deceasedInd"
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedInd",
"short" : "sdtc:deceasedInd",
"comment" : "This patient MAY contain zero or one [0..1] sdtc:deceasedInd (CONF:4537-32990).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.sdtcDeceasedInd",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/BL"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString" : "deceasedTime"
},
{
"url" : "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement",
"valueBoolean" : true
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime",
"short" : "ð—¨ð—¦ð—–ð——ð—œ: Date of Death",
"comment" : "This patient MAY contain zero or one [0..1] sdtc:deceasedTime (CONF:4537-32988).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.sdtcDeceasedTime",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/TS"
}
],
"constraint" : [
{
"key" : "should-value-att",
"severity" : "warning",
"human" : "SHOULD contain @value",
"expression" : "value.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
},
{
"key" : "ts-shall-year",
"severity" : "error",
"human" : "**SHALL** be precise to at least the year",
"expression" : "nullFlavor.exists() or value.toString().length() >= 4",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
},
{
"key" : "ts-should-day",
"severity" : "warning",
"human" : "**SHOULD** be precise to at least the day",
"expression" : "nullFlavor.exists() or value.toString().length() >= 10",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.sdtcMultipleBirthInd",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString" : "multipleBirthInd"
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.patient.sdtcMultipleBirthInd",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.sdtcMultipleBirthInd",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/BL"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.sdtcMultipleBirthOrderNumber",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString" : "multipleBirthOrderNumber"
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.patient.sdtcMultipleBirthOrderNumber",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.sdtcMultipleBirthOrderNumber",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/INT-POS"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.maritalStatusCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.maritalStatusCode",
"comment" : "This patient SHOULD contain zero or one [0..1] maritalStatusCode, which SHALL be selected from ValueSet Marital Status urn:oid:2.16.840.1.113883.1.11.12212 DYNAMIC (CONF:4537-5303).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.maritalStatusCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.12212"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.religiousAffiliationCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.religiousAffiliationCode",
"comment" : "This patient MAY contain zero or one [0..1] religiousAffiliationCode, which SHALL be selected from ValueSet Religious Affiliation urn:oid:2.16.840.1.113883.1.11.19185 DYNAMIC (CONF:4537-5317).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.religiousAffiliationCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.19185"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.raceCode",
"extension" : [
{
"url" : "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement",
"valueBoolean" : true
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.patient.raceCode",
"short" : "ð—¨ð—¦ð—–ð——ð—œ: Race",
"comment" : "This patient SHALL contain exactly one [1..1] raceCode, which SHALL be selected from ValueSet Race Category Excluding Nulls urn:oid:2.16.840.1.113883.3.2074.1.1.3 DYNAMIC (CONF:4537-5322).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Patient.raceCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.2074.1.1.3"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString" : "raceCode"
},
{
"url" : "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement",
"valueBoolean" : true
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode",
"short" : "ð—¨ð—¦ð—–ð——ð—œ: Race - The sdtc:raceCode is only used to record additional values when the patient has indicated multiple races or additional race detail beyond the five categories required for Meaningful Use Stage 2. The prefix sdtc: SHALL be bound to the namespace “urn:hl7-org:sdtcâ€. The use of the namespace provides a necessary extension to CDA R2 for the use of the additional raceCode elements.",
"comment" : "This patient MAY contain zero or more [0..*] sdtc:raceCode, which SHALL be selected from ValueSet Race Value Set urn:oid:2.16.840.1.113883.1.11.14914 DYNAMIC (CONF:4537-7263).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Patient.sdtcRaceCode",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.14914"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.ethnicGroupCode",
"extension" : [
{
"url" : "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement",
"valueBoolean" : true
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.patient.ethnicGroupCode",
"short" : "ð—¨ð—¦ð—–ð——ð—œ: Ethnicity",
"comment" : "This patient SHALL contain exactly one [1..1] ethnicGroupCode, which SHALL be selected from ValueSet Ethnicity urn:oid:2.16.840.1.114222.4.11.837 DYNAMIC (CONF:4537-5323).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Patient.ethnicGroupCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.837"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.sdtcEthnicGroupCode",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString" : "ethnicGroupCode"
},
{
"url" : "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement",
"valueBoolean" : true
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.patient.sdtcEthnicGroupCode",
"short" : "ð—¨ð—¦ð—–ð——ð—œ: Ethnicity",
"comment" : "This patient MAY contain zero or more [0..*] ethnicGroupCode, which SHALL be selected from ValueSet Detailed Ethnicity urn:oid:2.16.840.1.114222.4.11.877 DYNAMIC (CONF:4537-32901).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Patient.sdtcEthnicGroupCode",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.877"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian",
"comment" : "This patient MAY contain zero or more [0..*] guardian (CONF:4537-5325).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Patient.guardian",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Guardian"
}
],
"constraint" : [
{
"key" : "should-us-code",
"severity" : "warning",
"human" : "SHOULD contain code",
"expression" : "code.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
},
{
"key" : "should-us-addr",
"severity" : "warning",
"human" : "SHOULD contain addr",
"expression" : "addr.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
},
{
"key" : "should-us-telecom",
"severity" : "warning",
"human" : "SHOULD contain telecom",
"expression" : "telecom.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.realmCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.realmCode",
"definition" : "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "InfrastructureRoot.realmCode",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId",
"definition" : "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "InfrastructureRoot.typeId",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
],
"constraint" : [
{
"key" : "II-1",
"severity" : "error",
"human" : "An II instance must have either a root or an nullFlavor.",
"expression" : "root.exists() or nullFlavor.exists()",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId.assigningAuthorityName",
"representation" : [
"xmlAttr"
],
"label" : "Assigning Authority Name",
"definition" : "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.assigningAuthorityName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId.displayable",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId.displayable",
"representation" : [
"xmlAttr"
],
"label" : "Displayable",
"definition" : "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.displayable",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId.root",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId.root",
"representation" : [
"xmlAttr"
],
"label" : "Root",
"definition" : "Identifies the type as an HL7 Registered model",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.root",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/oid",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
],
"fixedString" : "2.16.840.1.113883.1.3"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId.extension",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId.extension",
"representation" : [
"xmlAttr"
],
"label" : "Extension",
"definition" : "A character string as a unique identifier within the scope of the identifier root.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.extension",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.templateId",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "InfrastructureRoot.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.classCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.classCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Guardian.classCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "GUARD",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-RoleClassAgent"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.id",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.id",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Guardian.id",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.sdtcIdentifiedBy",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString" : "identifiedBy"
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.sdtcIdentifiedBy",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Guardian.sdtcIdentifiedBy",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.code",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.code",
"comment" : "The guardian, if present, SHOULD contain zero or one [0..1] code, which SHALL be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:4537-5326).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Guardian.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.addr",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.addr",
"short" : "Base for all types and resources",
"definition" : "Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.",
"comment" : "The guardian, if present, SHOULD contain zero or more [0..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5359).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Guardian.addr",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/AD",
"profile" : [
"http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
]
}
],
"constraint" : [
{
"key" : "shall-city",
"severity" : "error",
"human" : "SHALL contain exactly one [1..1] city (CONF:81-7292).",
"expression" : "nullFlavor.exists() or item.city.count() = 1",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "shall-streetAddressLine",
"severity" : "error",
"human" : "SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291).",
"expression" : "nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4)",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "should-use",
"severity" : "warning",
"human" : "SHOULD contain @use",
"expression" : "nullFlavor.exists() or use.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "should-country",
"severity" : "warning",
"human" : "SHOULD contain country",
"expression" : "nullFlavor.exists() or item.country.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "81-7296",
"severity" : "error",
"human" : "**SHALL NOT** have mixed content except for white space (CONF:81-7296)",
"expression" : "item.xmlText.empty()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "81-10024",
"severity" : "error",
"human" : "If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024).",
"expression" : "nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state'))",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "81-10025",
"severity" : "error",
"human" : "If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).",
"expression" : "nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?'))",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "shall-max-ad-parts",
"severity" : "error",
"human" : "SHALL have at most one of each: state, city, postalCode, and country",
"expression" : "(item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1)",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
}
],
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom",
"comment" : "The guardian, if present, SHOULD contain zero or more [0..*] telecom (CONF:4537-5382).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Guardian.telecom",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/TEL"
}
],
"constraint" : [
{
"key" : "should-use",
"severity" : "warning",
"human" : "SHOULD contain @use",
"expression" : "nullFlavor.exists() or use.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.value",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.value",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "TEL.value",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "url",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/url"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.useablePeriod",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-defaulttype",
"valueCanonical" : "http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS"
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.useablePeriod",
"representation" : [
"typeAttr"
],
"label" : "Useable Period",
"definition" : "Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "TEL.useablePeriod",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"
},
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS"
},
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS"
},
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.use",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.use",
"representation" : [
"xmlAttr"
],
"label" : "Use Code",
"definition" : "One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.",
"comment" : "The telecom, if present, SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-7993).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TEL.use",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson",
"comment" : "The guardian, if present, SHALL contain exactly one [1..1] guardianPerson (CONF:4537-5385).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Guardian.guardianPerson",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Person"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.realmCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.realmCode",
"definition" : "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "InfrastructureRoot.realmCode",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId",
"definition" : "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "InfrastructureRoot.typeId",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
],
"constraint" : [
{
"key" : "II-1",
"severity" : "error",
"human" : "An II instance must have either a root or an nullFlavor.",
"expression" : "root.exists() or nullFlavor.exists()",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId.assigningAuthorityName",
"representation" : [
"xmlAttr"
],
"label" : "Assigning Authority Name",
"definition" : "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.assigningAuthorityName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId.displayable",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId.displayable",
"representation" : [
"xmlAttr"
],
"label" : "Displayable",
"definition" : "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.displayable",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId.root",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId.root",
"representation" : [
"xmlAttr"
],
"label" : "Root",
"definition& "profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "DEL"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country",
"definition" : "Country",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.country",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
}
],
"constraint" : [
{
"key" : "text-null",
"severity" : "error",
"human" : "xmlText and nullFlavor are mutually exclusive (one must be present)",
"expression" : "(xmlText | nullFlavor).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.representation",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "TXT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.mediaType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.language",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ADXP.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "CNT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state",
"definition" : "A sub-unit of a country with limited sovereignty in a federally organized country.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.state",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
}
],
"constraint" : [
{
"key" : "text-null",
"severity" : "error",
"human" : "xmlText and nullFlavor are mutually exclusive (one must be present)",
"expression" : "(xmlText | nullFlavor).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.representation",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "TXT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.mediaType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.language",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ADXP.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "STA"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county",
"definition" : "A sub-unit of a state or province. (49 of the United States of America use the term \"county;\" Louisiana uses the term \"parish\".)",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.county",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
}
],
"constraint" : [
{
"key" : "text-null",
"severity" : "error",
"human" : "xmlText and nullFlavor are mutually exclusive (one must be present)",
"expression" : "(xmlText | nullFlavor).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.representation",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "TXT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.mediaType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.language",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ADXP.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "CPA"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city",
"definition" : "The name of the city, town, village, or other community or delivery center",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.city",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
}
],
"constraint" : [
{
"key" : "text-null",
"severity" : "error",
"human" : "xmlText and nullFlavor are mutually exclusive (one must be present)",
"expression" : "(xmlText | nullFlavor).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.representation",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "TXT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.mediaType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.language",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ADXP.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "CTY"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode",
"definition" : "A postal code designating a region defined by the postal service.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.postalCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
}
],
"constraint" : [
{
"key" : "text-null",
"severity" : "error",
"human" : "xmlText and nullFlavor are mutually exclusive (one must be present)",
"expression" : "(xmlText | nullFlavor).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.representation",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "TXT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.mediaType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.language",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ADXP.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "ZIP"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine",
"definition" : "Street address line",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.streetAddressLine",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
}
],
"constraint" : [
{
"key" : "text-null",
"severity" : "error",
"human" : "xmlText and nullFlavor are mutually exclusive (one must be present)",
"expression" : "(xmlText | nullFlavor).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.representation",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "TXT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.mediaType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.language",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ADXP.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "SAL"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber",
"definition" : "The number of a building, house or lot alongside the street. Also known as \"primary street number\". This does not number the street but rather the building.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.houseNumber",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
}
],
"constraint" : [
{
"key" : "text-null",
"severity" : "error",
"human" : "xmlText and nullFlavor are mutually exclusive (one must be present)",
"expression" : "(xmlText | nullFlavor).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.representation",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "TXT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.mediaType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.language",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ADXP.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "BNR"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric",
"definition" : "The numeric portion of a building number",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.houseNumberNumeric",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
}
],
"constraint" : [
{
"key" : "text-null",
"severity" : "error",
"human" : "xmlText and nullFlavor are mutually exclusive (one must be present)",
"expression" : "(xmlText | nullFlavor).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.representation",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "TXT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.mediaType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.language",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ADXP.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "BNN"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction",
"definition" : "Direction (e.g., N, S, W, E)",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.direction",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
}
],
"constraint" : [
{
"key" : "text-null",
"severity" : "error",
"human" : "xmlText and nullFlavor are mutually exclusive (one must be present)",
"expression" : "(xmlText | nullFlavor).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.representation",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "TXT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.mediaType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.language",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ADXP.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "DIR"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName",
"definition" : "Name of a roadway or artery recognized by a municipality (including street type and direction)",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.streetName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
}
],
"constraint" : [
{
"key" : "text-null",
"severity" : "error",
"human" : "xmlText and nullFlavor are mutually exclusive (one must be present)",
"expression" : "(xmlText | nullFlavor).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.representation",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "TXT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.mediaType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.language",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ADXP.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "STR"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase",
"definition" : "The base name of a roadway or artery recognized by a municipality (excluding street type and direction)",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.streetNameBase",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
}
],
"constraint" : [
{
"key" : "text-null",
"severity" : "error",
"human" : "xmlText and nullFlavor are mutually exclusive (one must be present)",
"expression" : "(xmlText | nullFlavor).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.representation",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "TXT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.mediaType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.language",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ADXP.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "STB"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType",
"definition" : "The designation given to the street. (e.g. Street, Avenue, Crescent, etc.)",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.streetNameType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
}
],
"constraint" : [
{
"key" : "text-null",
"severity" : "error",
"human" : "xmlText and nullFlavor are mutually exclusive (one must be present)",
"expression" : "(xmlText | nullFlavor).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.representation",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "TXT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.mediaType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.language",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ADXP.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "STTYP"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator",
"definition" : "This can be a unit designator, such as apartment number, suite number, or floor. There may be several unit designators in an address (e.g., \"3rd floor, Appt. 342\"). This can also be a designator pointing away from the location, rather than specifying a smaller location within some larger one (e.g., Dutch \"t.o.\" means \"opposite to\" for house boats located across the street facing houses).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.additionalLocator",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
}
],
"constraint" : [
{
"key" : "text-null",
"severity" : "error",
"human" : "xmlText and nullFlavor are mutually exclusive (one must be present)",
"expression" : "(xmlText | nullFlavor).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.representation",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "TXT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.mediaType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.language",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ADXP.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "ADL"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID",
"definition" : "The number or name of a specific unit contained within a building or complex, as assigned by that building or complex.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.unitID",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
}
],
"constraint" : [
{
"key" : "text-null",
"severity" : "error",
"human" : "xmlText and nullFlavor are mutually exclusive (one must be present)",
"expression" : "(xmlText | nullFlavor).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.representation",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "TXT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.mediaType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.language",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ADXP.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "UNID"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType",
"definition" : "Indicates the type of specific unit contained within a building or complex. E.g. Appartment, Floor",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.unitType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
}
],
"constraint" : [
{
"key" : "text-null",
"severity" : "error",
"human" : "xmlText and nullFlavor are mutually exclusive (one must be present)",
"expression" : "(xmlText | nullFlavor).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.representation",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "TXT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.mediaType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.language",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ADXP.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "UNIT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf",
"definition" : "The name of the party who will take receipt at the specified address, and will take on responsibility for ensuring delivery to the target recipient",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.careOf",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
}
],
"constraint" : [
{
"key" : "text-null",
"severity" : "error",
"human" : "xmlText and nullFlavor are mutually exclusive (one must be present)",
"expression" : "(xmlText | nullFlavor).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.representation",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "TXT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.mediaType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.language",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ADXP.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "CAR"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract",
"definition" : "A geographic sub-unit delineated for demographic purposes.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.censusTract",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
}
],
"constraint" : [
{
"key" : "text-null",
"severity" : "error",
"human" : "xmlText and nullFlavor are mutually exclusive (one must be present)",
"expression" : "(xmlText | nullFlavor).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.representation",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "TXT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.mediaType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.language",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ADXP.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "CEN"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine",
"definition" : "A delivery address line is frequently used instead of breaking out delivery mode, delivery installation, etc. An address generally has only a delivery address line or a street address line, but not both.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.deliveryAddressLine",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
}
],
"constraint" : [
{
"key" : "text-null",
"severity" : "error",
"human" : "xmlText and nullFlavor are mutually exclusive (one must be present)",
"expression" : "(xmlText | nullFlavor).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.representation",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "TXT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.mediaType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.language",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ADXP.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "DAL"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType",
"definition" : "Indicates the type of delivery installation (the facility to which the mail will be delivered prior to final shipping via the delivery mode.) Example: post office, letter carrier depot, community mail center, station, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.deliveryInstallationType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
}
],
"constraint" : [
{
"key" : "text-null",
"severity" : "error",
"human" : "xmlText and nullFlavor are mutually exclusive (one must be present)",
"expression" : "(xmlText | nullFlavor).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.representation",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "TXT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.mediaType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.language",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ADXP.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "DINST"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea",
"definition" : "The location of the delivery installation, usually a town or city, and is only required if the area is different from the municipality. Area to which mail delivery service is provided from any postal facility or service such as an individual letter carrier, rural route, or postal route.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.deliveryInstallationArea",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
}
],
"constraint" : [
{
"key" : "text-null",
"severity" : "error",
"human" : "xmlText and nullFlavor are mutually exclusive (one must be present)",
"expression" : "(xmlText | nullFlavor).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.representation",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "TXT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.mediaType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.language",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ADXP.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "DINSTA"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier",
"definition" : "A number, letter or name identifying a delivery installation. E.g., for Station A, the delivery installation qualifier would be 'A'.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.deliveryInstallationQualifier",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
}
],
"constraint" : [
{
"key" : "text-null",
"severity" : "error",
"human" : "xmlText and nullFlavor are mutually exclusive (one must be present)",
"expression" : "(xmlText | nullFlavor).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.representation",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "TXT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.mediaType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.language",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ADXP.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "DINSTQ"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode",
"definition" : "Indicates the type of service offered, method of delivery. For example: post office box, rural route, general delivery, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.deliveryMode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
}
],
"constraint" : [
{
"key" : "text-null",
"severity" : "error",
"human" : "xmlText and nullFlavor are mutually exclusive (one must be present)",
"expression" : "(xmlText | nullFlavor).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.representation",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "TXT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.mediaType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.language",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ADXP.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "DMOD"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier",
"definition" : "Represents the routing information such as a letter carrier route number. It is the identifying number of the designator (the box number or rural route number).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.deliveryModeIdentifier",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
}
],
"constraint" : [
{
"key" : "text-null",
"severity" : "error",
"human" : "xmlText and nullFlavor are mutually exclusive (one must be present)",
"expression" : "(xmlText | nullFlavor).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.representation",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "TXT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.mediaType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.language",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ADXP.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "DMODID"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix",
"definition" : "Any alphabetic character, fraction or other text that may appear after the numeric portion of a building number",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.buildingNumberSuffix",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
}
],
"constraint" : [
{
"key" : "text-null",
"severity" : "error",
"human" : "xmlText and nullFlavor are mutually exclusive (one must be present)",
"expression" : "(xmlText | nullFlavor).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.representation",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "TXT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.mediaType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.language",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ADXP.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "BNS"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox",
"definition" : "A numbered box located in a post station.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.postBox",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
}
],
"constraint" : [
{
"key" : "text-null",
"severity" : "error",
"human" : "xmlText and nullFlavor are mutually exclusive (one must be present)",
"expression" : "(xmlText | nullFlavor).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.representation",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "TXT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.mediaType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.language",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ADXP.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "POB"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct",
"definition" : "A subsection of a municipality",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.precinct",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
}
],
"constraint" : [
{
"key" : "text-null",
"severity" : "error",
"human" : "xmlText and nullFlavor are mutually exclusive (one must be present)",
"expression" : "(xmlText | nullFlavor).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.representation",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "TXT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.mediaType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.language",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ADXP.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "PRE"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.useablePeriod",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-defaulttype",
"valueCanonical" : "http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS"
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.useablePeriod",
"representation" : [
"typeAttr"
],
"label" : "Useable Period",
"definition" : "A General Timing Specification (GTS) specifying the periods of time during which the address can be used. This is used to specify different addresses for different times of the week or year.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AD.useablePeriod",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"
},
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS"
},
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS"
},
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication",
"extension" : [
{
"url" : "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement",
"valueBoolean" : true
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication",
"short" : "ð—¨ð—¦ð—–ð——ð—œ: Preferred Language",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Patient.languageCommunication",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/LanguageCommunication"
}
],
"constraint" : [
{
"key" : "should-proficiencyLevelCode",
"severity" : "warning",
"human" : "SHOULD contain proficiencyLevelCode",
"expression" : "proficiencyLevelCode.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
},
{
"key" : "should-preferenceInd",
"severity" : "warning",
"human" : "SHOULD contain preferenceInd",
"expression" : "preferenceInd.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.realmCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.realmCode",
"definition" : "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "InfrastructureRoot.realmCode",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.typeId",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.typeId",
"definition" : "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "InfrastructureRoot.typeId",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
],
"constraint" : [
{
"key" : "II-1",
"severity" : "error",
"human" : "An II instance must have either a root or an nullFlavor.",
"expression" : "root.exists() or nullFlavor.exists()",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.typeId.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.typeId.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.typeId.assigningAuthorityName",
"representation" : [
"xmlAttr"
],
"label" : "Assigning Authority Name",
"definition" : "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.assigningAuthorityName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.typeId.displayable",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.typeId.displayable",
"representation" : [
"xmlAttr"
],
"label" : "Displayable",
"definition" : "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.displayable",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.typeId.root",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.typeId.root",
"representation" : [
"xmlAttr"
],
"label" : "Root",
"definition" : "Identifies the type as an HL7 Registered model",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.root",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/oid",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
],
"fixedString" : "2.16.840.1.113883.1.3"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.typeId.extension",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.typeId.extension",
"representation" : [
"xmlAttr"
],
"label" : "Extension",
"definition" : "A character string as a unique identifier within the scope of the identifier root.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.extension",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.templateId",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "InfrastructureRoot.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.languageCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.languageCode",
"min" : 1,
"max" : "1",
"base" : {
"path" : "LanguageCommunication.languageCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/fhir/us/core/ValueSet/simple-language"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.modeCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.modeCode",
"comment" : "The languageCommunication, if present, MAY contain zero or one [0..1] modeCode, which SHALL be selected from ValueSet LanguageAbilityMode urn:oid:2.16.840.1.113883.1.11.12249 DYNAMIC (CONF:4537-5409).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "LanguageCommunication.modeCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.12249"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.proficiencyLevelCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.proficiencyLevelCode",
"comment" : "The languageCommunication, if present, SHOULD contain zero or one [0..1] proficiencyLevelCode, which SHALL be selected from ValueSet LanguageAbilityProficiency urn:oid:2.16.840.1.113883.1.11.12199 DYNAMIC (CONF:4537-9965).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "LanguageCommunication.proficiencyLevelCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.12199"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.preferenceInd",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.preferenceInd",
"comment" : "The languageCommunication, if present, SHOULD contain zero or one [0..1] preferenceInd (CONF:4537-5414).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "LanguageCommunication.preferenceInd",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/BL"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization",
"comment" : "This patientRole MAY contain zero or one [0..1] providerOrganization (CONF:4537-5416).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PatientRole.providerOrganization",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Organization"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.realmCode",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.realmCode",
"definition" : "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "InfrastructureRoot.realmCode",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.typeId",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.typeId",
"definition" : "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "InfrastructureRoot.typeId",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
],
"constraint" : [
{
"key" : "II-1",
"severity" : "error",
"human" : "An II instance must have either a root or an nullFlavor.",
"expression" : "root.exists() or nullFlavor.exists()",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.typeId.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.typeId.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.typeId.assigningAuthorityName",
"representation" : [
"xmlAttr"
],
"label" : "Assigning Authority Name",
"definition" : "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.assigningAuthorityName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.typeId.displayable",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.typeId.displayable",
"representation" : [
"xmlAttr"
],
"label" : "Displayable",
"definition" : "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.displayable",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.typeId.root",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.typeId.root",
"representation" : [
"xmlAttr"
],
"label" : "Root",
"definition" : "Identifies the type as an HL7 Registered model",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.root",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/oid",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
],
"fixedString" : "2.16.840.1.113883.1.3"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.typeId.extension",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.typeId.extension",
"representation" : [
"xmlAttr"
],
"label" : "Extension",
"definition" : "A character string as a unique identifier within the scope of the identifier root.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.extension",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.templateId",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "InfrastructureRoot.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.classCode",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.classCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Organization.classCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "ORG",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.determinerCode",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.determinerCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Organization.determinerCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "INSTANCE",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityDeterminer"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.id",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.id",
"comment" : "The providerOrganization, if present, SHALL contain at least one [1..*] id (CONF:4537-5417).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "Organization.id",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.id.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.id.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.id.assigningAuthorityName",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.id.assigningAuthorityName",
"representation" : [
"xmlAttr"
],
"label" : "Assigning Authority Name",
"definition" : "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.assigningAuthorityName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.id.displayable",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.id.displayable",
"representation" : [
"xmlAttr"
],
"label" : "Displayable",
"definition" : "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.displayable",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.id.root",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.id.root",
"representation" : [
"xmlAttr"
],
"label" : "Root",
"definition" : "A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.",
"comment" : "Such ids SHOULD contain zero or one [0..1] @root=\"2.16.840.1.113883.4.6\" National Provider Identifier (CONF:4537-16820).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.root",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/oid",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
],
"constraint" : [
{
"key" : "should-npi",
"severity" : "warning",
"human" : "SHOULD be NPI",
"expression" : "$this = '2.16.840.1.113883.4.6'",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.id.extension",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.id.extension",
"representation" : [
"xmlAttr"
],
"label" : "Extension",
"definition" : "A character string as a unique identifier within the scope of the identifier root.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.extension",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.name",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.name",
"comment" : "The providerOrganization, if present, SHALL contain at least one [1..*] name (CONF:4537-5419).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "Organization.name",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ON"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom",
"comment" : "The providerOrganization, if present, SHALL contain at least one [1..*] telecom (CONF:4537-5420).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "Organization.telecom",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/TEL"
}
],
"constraint" : [
{
"key" : "should-use",
"severity" : "warning",
"human" : "SHOULD contain @use",
"expression" : "nullFlavor.exists() or use.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.value",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.value",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "TEL.value",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "url",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/url"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.useablePeriod",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-defaulttype",
"valueCanonical" : "http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS"
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.useablePeriod",
"representation" : [
"typeAttr"
],
"label" : "Useable Period",
"definition" : "Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "TEL.useablePeriod",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"
},
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS"
},
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS"
},
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.use",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.use",
"representation" : [
"xmlAttr"
],
"label" : "Use Code",
"definition" : "One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.",
"comment" : "Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-7994).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TEL.use",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.addr",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.addr",
"short" : "Base for all types and resources",
"definition" : "Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.",
"comment" : "The providerOrganization, if present, SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5422).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "Organization.addr",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/AD",
"profile" : [
"http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
]
}
],
"constraint" : [
{
"key" : "shall-city",
"severity" : "error",
"human" : "SHALL contain exactly one [1..1] city (CONF:81-7292).",
"expression" : "nullFlavor.exists() or item.city.count() = 1",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "shall-streetAddressLine",
"severity" : "error",
"human" : "SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291).",
"expression" : "nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4)",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "should-use",
"severity" : "warning",
"human" : "SHOULD contain @use",
"expression" : "nullFlavor.exists() or use.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "should-country",
"severity" : "warning",
"human" : "SHOULD contain country",
"expression" : "nullFlavor.exists() or item.country.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "81-7296",
"severity" : "error",
"human" : "**SHALL NOT** have mixed content except for white space (CONF:81-7296)",
"expression" : "item.xmlText.empty()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "81-10024",
"severity" : "error",
"human" : "If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024).",
"expression" : "nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state'))",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "81-10025",
"severity" : "error",
"human" : "If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).",
"expression" : "nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?'))",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "shall-max-ad-parts",
"severity" : "error",
"human" : "SHALL have at most one of each: state, city, postalCode, and country",
"expression" : "(item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1)",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
}
],
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.standardIndustryClassCode",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.standardIndustryClassCode",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Organization.standardIndustryClassCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "example",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-OrganizationIndustryClassNAICS"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.asOrganizationPartOf",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.asOrganizationPartOf",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Organization.asOrganizationPartOf",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/OrganizationPartOf"
}
]
},
{
"id" : "ClinicalDocument.author",
"path" : "ClinicalDocument.author",
"short" : "The author element represents the creator of the clinical document. The author may be a device or a person.",
"comment" : "SHALL contain at least one [1..*] author (CONF:4537-5444).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "ClinicalDocument.author",
"min" : 1,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Author"
}
]
},
{
"id" : "ClinicalDocument.author.nullFlavor",
"path" : "ClinicalDocument.author.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.author.realmCode",
"path" : "ClinicalDocument.author.realmCode",
"definition" : "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "InfrastructureRoot.realmCode",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
]
},
{
"id" : "ClinicalDocument.author.typeId",
"path" : "ClinicalDocument.author.typeId",
"definition" : "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "InfrastructureRoot.typeId",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
],
"constraint" : [
{
"key" : "II-1",
"severity" : "error",
"human" : "An II instance must have either a root or an nullFlavor.",
"expression" : "root.exists() or nullFlavor.exists()",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
}
]
},
{
"id" : "ClinicalDocument.author.typeId.nullFlavor",
"path" : "ClinicalDocument.author.typeId.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.author.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.author.typeId.assigningAuthorityName",
"representation" : [
"xmlAttr"
],
"label" : "Assigning Authority Name",
"definition" : "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.assigningAuthorityName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.author.typeId.displayable",
"path" : "ClinicalDocument.author.typeId.displayable",
"representation" : [
"xmlAttr"
],
"label" : "Displayable",
"definition" : "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.displayable",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id" : "ClinicalDocument.author.typeId.root",
"path" : "ClinicalDocument.author.typeId.root",
"representation" : [
"xmlAttr"
],
"label" : "Root",
"definition" : "Identifies the type as an HL7 Registered model",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.root",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/oid",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
],
"fixedString" : "2.16.840.1.113883.1.3"
},
{
"id" : "ClinicalDocument.author.typeId.extension",
"path" : "ClinicalDocument.author.typeId.extension",
"representation" : [
"xmlAttr"
],
"label" : "Extension",
"definition" : "A character string as a unique identifier within the scope of the identifier root.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.extension",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.author.templateId",
"path" : "ClinicalDocument.author.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "InfrastructureRoot.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.author.typeCode",
"path" : "ClinicalDocument.author.typeCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Author.typeCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "AUT",
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType"
}
},
{
"id" : "ClinicalDocument.author.contextControlCode",
"path" : "ClinicalDocument.author.contextControlCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Author.contextControlCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "OP",
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAContextControl"
}
},
{
"id" : "ClinicalDocument.author.functionCode",
"path" : "ClinicalDocument.author.functionCode",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Author.functionCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
]
},
{
"id" : "ClinicalDocument.author.time",
"path" : "ClinicalDocument.author.time",
"short" : "Base for all types and resources",
"definition" : "A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.",
"comment" : "Such authors SHALL contain exactly one [1..1] US Realm Date and Time (Point in Time) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5445).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Author.time",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/TS",
"profile" : [
"http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTime"
]
}
],
"constraint" : [
{
"key" : "ts-shall-day",
"severity" : "error",
"human" : "**SHALL** be precise to at least the day",
"expression" : "nullFlavor.exists() or value.toString().length() >= 10",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTime"
},
{
"key" : "ts-should-minute",
"severity" : "warning",
"human" : "**SHOULD** be precise to at least the minute",
"expression" : "nullFlavor.exists() or value.toString().length() > 10",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTime"
}
],
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor",
"path" : "ClinicalDocument.author.assignedAuthor",
"comment" : "Such authors SHALL contain exactly one [1..1] assignedAuthor (CONF:4537-5448).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Author.assignedAuthor",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/AssignedAuthor"
}
],
"constraint" : [
{
"key" : "4537-16790",
"severity" : "error",
"human" : "There **SHALL** be exactly one assignedAuthor/assignedPerson or exactly one assignedAuthor/assignedAuthoringDevice (CONF:4537-16790).",
"expression" : "(assignedPerson | assignedAuthoringDevice).count() = 1",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
},
{
"key" : "should-id-npi",
"severity" : "warning",
"human" : "SHOULD contain an id with root='2.16.840.1.113883.4.6' (NPI)",
"expression" : "id.where(root = '2.16.840.1.113883.4.6')",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
},
{
"key" : "should-us-code",
"severity" : "warning",
"human" : "SHOULD contain code",
"expression" : "code.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.nullFlavor",
"path" : "ClinicalDocument.author.assignedAuthor.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.author.assignedAuthor.realmCode",
"path" : "ClinicalDocument.author.assignedAuthor.realmCode",
"definition" : "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "InfrastructureRoot.realmCode",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.typeId",
"path" : "ClinicalDocument.author.assignedAuthor.typeId",
"definition" : "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "InfrastructureRoot.typeId",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
],
"constraint" : [
{
"key" : "II-1",
"severity" : "error",
"human" : "An II instance must have either a root or an nullFlavor.",
"expression" : "root.exists() or nullFlavor.exists()",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.typeId.nullFlavor",
"path" : "ClinicalDocument.author.assignedAuthor.typeId.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.author.assignedAuthor.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.author.assignedAuthor.typeId.assigningAuthorityName",
"representation" : [
"xmlAttr"
],
"label" : "Assigning Authority Name",
"definition" : "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.assigningAuthorityName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.typeId.displayable",
"path" : "ClinicalDocument.author.assignedAuthor.typeId.displayable",
"representation" : [
"xmlAttr"
],
"label" : "Displayable",
"definition" : "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.displayable",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.typeId.root",
"path" : "ClinicalDocument.author.assignedAuthor.typeId.root",
"representation" : [
"xmlAttr"
],
"label" : "Root",
"definition" : "Identifies the type as an HL7 Registered model",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.root",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/oid",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
],
"fixedString" : "2.16.840.1.113883.1.3"
},
{
"id" : "ClinicalDocument.author.assignedAuthor.typeId.extension",
"path" : "ClinicalDocument.author.assignedAuthor.typeId.extension",
"representation" : [
"xmlAttr"
],
"label" : "Extension",
"definition" : "A character string as a unique identifier within the scope of the identifier root.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.extension",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.templateId",
"path" : "ClinicalDocument.author.assignedAuthor.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "InfrastructureRoot.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.classCode",
"path" : "ClinicalDocument.author.assignedAuthor.classCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "AssignedAuthor.classCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "ASSIGNED",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity"
}
},
{
"id" : "ClinicalDocument.author.assignedAuthor.id",
"path" : "ClinicalDocument.author.assignedAuthor.id",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "root"
}
],
"rules" : "open"
},
"comment" : "This assignedAuthor SHOULD contain zero or one [0..1] id (CONF:4537-32882) such that it, This assignedAuthor SHALL contain at least one [1..*] id (CONF:4537-5449).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "AssignedAuthor.id",
"min" : 1,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.id:npi",
"path" : "ClinicalDocument.author.assignedAuthor.id",
"sliceName" : "npi",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AssignedAuthor.id",
"min" : 1,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
],
"constraint" : [
{
"key" : "should-extension",
"severity" : "warning",
"human" : "SHOULD contain extension",
"expression" : "extension.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.id:npi.nullFlavor",
"path" : "ClinicalDocument.author.assignedAuthor.id.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"short" : "If NPI is unknown, set @nullFlavor to UNK",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.author.assignedAuthor.id:npi.assigningAuthorityName",
"path" : "ClinicalDocument.author.assignedAuthor.id.assigningAuthorityName",
"representation" : [
"xmlAttr"
],
"label" : "Assigning Authority Name",
"definition" : "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.assigningAuthorityName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.id:npi.displayable",
"path" : "ClinicalDocument.author.assignedAuthor.id.displayable",
"representation" : [
"xmlAttr"
],
"label" : "Displayable",
"definition" : "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.displayable",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.id:npi.root",
"path" : "ClinicalDocument.author.assignedAuthor.id.root",
"representation" : [
"xmlAttr"
],
"label" : "Root",
"definition" : "A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.",
"comment" : "SHALL contain exactly one [1..1] @root=\"2.16.840.1.113883.4.6\" National Provider Identifier (CONF:4537-32884).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.root",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/oid",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
],
"patternString" : "2.16.840.1.113883.4.6"
},
{
"id" : "ClinicalDocument.author.assignedAuthor.id:npi.extension",
"path" : "ClinicalDocument.author.assignedAuthor.id.extension",
"representation" : [
"xmlAttr"
],
"label" : "Extension",
"definition" : "A character string as a unique identifier within the scope of the identifier root.",
"comment" : "SHOULD contain zero or one [0..1] @extension (CONF:4537-32885).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.extension",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.sdtcIdentifiedBy",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString" : "identifiedBy"
}
],
"path" : "ClinicalDocument.author.assignedAuthor.sdtcIdentifiedBy",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AssignedAuthor.sdtcIdentifiedBy",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.code",
"path" : "ClinicalDocument.author.assignedAuthor.code",
"short" : "Only if this assignedAuthor is an assignedPerson should the assignedAuthor contain a code.",
"comment" : "This assignedAuthor SHOULD contain zero or one [0..1] code (CONF:4537-16787).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AssignedAuthor.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "example",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDARoleCode"
}
},
{
"id" : "ClinicalDocument.author.assignedAuthor.code.nullFlavor",
"path" : "ClinicalDocument.author.assignedAuthor.code.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.author.assignedAuthor.code.code",
"path" : "ClinicalDocument.author.assignedAuthor.code.code",
"representation" : [
"xmlAttr"
],
"label" : "Code",
"definition" : "The plain code symbol defined by the code system. For example, \"784.0\" is the code symbol of the ICD-9 code \"784.0\" for headache.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CD.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "preferred",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066"
}
},
{
"id" : "ClinicalDocument.author.assignedAuthor.code.codeSystem",
"path" : "ClinicalDocument.author.assignedAuthor.code.codeSystem",
"representation" : [
"xmlAttr"
],
"label" : "Code System",
"definition" : "Specifies the code system that defines the code.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.codeSystem",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/oid",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.code.codeSystemName",
"path" : "ClinicalDocument.author.assignedAuthor.code.codeSystemName",
"representation" : [
"xmlAttr"
],
"label" : "Code System Name",
"definition" : "The common name of the coding system.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.codeSystemName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.code.codeSystemVersion",
"path" : "ClinicalDocument.author.assignedAuthor.code.codeSystemVersion",
"representation" : [
"xmlAttr"
],
"label" : "Code System Version",
"definition" : "If applicable, a version descriptor defined specifically for the given code system.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.codeSystemVersion",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.code.displayName",
"path" : "ClinicalDocument.author.assignedAuthor.code.displayName",
"representation" : [
"xmlAttr"
],
"label" : "Display Name",
"definition" : "A name or title for the code, under which the sending system shows the code value to its users.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.displayName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.code.sdtcValueSet",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString" : "valueSet"
}
],
"path" : "ClinicalDocument.author.assignedAuthor.code.sdtcValueSet",
"representation" : [
"xmlAttr"
],
"definition" : "The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.valueSet",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/oid"
]
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.code.sdtcValueSetVersion",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString" : "valueSetVersion"
}
],
"path" : "ClinicalDocument.author.assignedAuthor.code.sdtcValueSetVersion",
"representation" : [
"xmlAttr"
],
"definition" : "The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.sdtcValueSetVersion",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.code.originalText",
"path" : "ClinicalDocument.author.assignedAuthor.code.originalText",
"label" : "Original Text",
"definition" : "The text or phrase used as the basis for the coding.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.originalText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ED"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.code.qualifier",
"path" : "ClinicalDocument.author.assignedAuthor.code.qualifier",
"label" : "Qualifier",
"definition" : "Specifies additional codes that increase the specificity of the the primary code.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "CD.qualifier",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CR"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.code.translation",
"path" : "ClinicalDocument.author.assignedAuthor.code.translation",
"representation" : [
"typeAttr"
],
"label" : "Translation",
"definition" : "A set of other concept descriptors that translate this concept descriptor into other code systems.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CD.translation",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CD"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.addr",
"path" : "ClinicalDocument.author.assignedAuthor.addr",
"short" : "Base for all types and resources",
"definition" : "Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.",
"comment" : "This assignedAuthor SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5452).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "AssignedAuthor.addr",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/AD",
"profile" : [
"http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
]
}
],
"constraint" : [
{
"key" : "shall-city",
"severity" : "error",
"human" : "SHALL contain exactly one [1..1] city (CONF:81-7292).",
"expression" : "nullFlavor.exists() or item.city.count() = 1",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "shall-streetAddressLine",
"severity" : "error",
"human" : "SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291).",
"expression" : "nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4)",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "should-use",
"severity" : "warning",
"human" : "SHOULD contain @use",
"expression" : "nullFlavor.exists() or use.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "should-country",
"severity" : "warning",
"human" : "SHOULD contain country",
"expression" : "nullFlavor.exists() or item.country.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "81-7296",
"severity" : "error",
"human" : "**SHALL NOT** have mixed content except for white space (CONF:81-7296)",
"expression" : "item.xmlText.empty()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "81-10024",
"severity" : "error",
"human" : "If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024).",
"expression" : "nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state'))",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.dataEnterer.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.dataEnterer.typeId.assigningAuthorityName",
"representation" : [
"xmlAttr"
],
"label" : "Assigning Authority Name",
"definition" : "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"min" : 0,
"max" : "1",
"base" : {
&nbs },
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
],
"constraint" : [
{
"key" : "II-1",
"severity" : "error",
"human" : "An II instance must have either a root or an nullFlavor.",
"expression" : "root.exists() or nullFlavor.exists()",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
}
]
},
{
"id" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.typeId.nullFlavor",
"path" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.typeId.nullFlavor",
"representation" : [
"xmlAttr"
&nb "ClinicalDocument.authenticator.signatureCode",
"comment" : "SHALL contain exactly one [1..1] signatureCode (CONF:4537-5610).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Authenticator.signatureCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
],
"constraint" : [
{
"key" : "signature",
"severity" : "warning",
"human" : "CDA Release One represented either an intended ('X') or actual ('S') authenticator. CDA Release Two only represents an actual authenticator, so has deprecated the value of 'X'.",
"expression" : "code.exists() implies code != & min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.componentOf.realmCode",
"path" : "ClinicalDocument.componentOf.realmCode",
"definition" : "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "InfrastructureRoot.realmCode",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
]
},
{
"id" : "ClinicalDocument.componentOf.typeId",
"path" : "ClinicalDocument.componentOf.typeId",
"definition" : "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "InfrastructureRoot.typeId",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
],
"constraint" : [
{
"key" : "II-1",
"severity" : "error",
"human" : "An II instance must have either a root or an nullFlavor.",
"expression" : "root.exists() or nullFlavor.exists()",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
}
]
},
{
"id" : "ClinicalDocument.componentOf.typeId.nullFlavor",
"path" : "ClinicalDocument.componentOf.typeId.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.componentOf.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.componentOf.typeId.assigningAuthorityName",
"representation" : [
"xmlAttr"
],
"label" : "Assigning Authority Name",
"definition" : "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.assigningAuthorityName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.componentOf.typeId.displayable",
"path" : "ClinicalDocument.componentOf.typeId.displayable",
"representation" : [
"xmlAttr"
],
"label" : "Displayable",
"definition" : "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.displayable",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id" : "ClinicalDocument.componentOf.typeId.root",
"path" : "ClinicalDocument.componentOf.typeId.root",
"representation" : [
"xmlAttr"
],
"label" : "Root",
"definition" : "Identifies the type as an HL7 Registered model",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.root",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/oid",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
],
"fixedString" : "2.16.840.1.113883.1.3"
},
{
"id" : "ClinicalDocument.componentOf.typeId.extension",
"path" : "ClinicalDocument.componentOf.typeId.extension",
"representation" : [
"xmlAttr"
],
"label" : "Extension",
"definition" : "A character string as a unique identifier within the scope of the identifier root.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.extension",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.componentOf.templateId",
"path" : "ClinicalDocument.componentOf.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "InfrastructureRoot.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.componentOf.typeCode",
"path" : "ClinicalDocument.componentOf.typeCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "ComponentOf.typeCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "COMP",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActRelationshipHasComponent"
}
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter",
"path" : "ClinicalDocument.componentOf.encompassingEncounter",
"comment" : "The componentOf, if present, SHALL contain exactly one [1..1] encompassingEncounter (CONF:4537-9956).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ComponentOf.encompassingEncounter",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/EncompassingEncounter"
}
],
"constraint" : [
{
"key" : "should-responsibleParty",
"severity" : "warning",
"human" : "SHOULD contain responsibleParty",
"expression" : "responsibleParty.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
}
]
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.nullFlavor",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.realmCode",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.realmCode",
"definition" : "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "InfrastructureRoot.realmCode",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
]
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.typeId",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.typeId",
"definition" : "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "InfrastructureRoot.typeId",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
],
"constraint" : [
{
"key" : "II-1",
"severity" : "error",
"human" : "An II instance must have either a root or an nullFlavor.",
"expression" : "root.exists() or nullFlavor.exists()",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
}
]
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.typeId.nullFlavor",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.typeId.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.typeId.assigningAuthorityName",
"representation" : [
"xmlAttr"
],
"label" : "Assigning Authority Name",
"definition" : "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.assigningAuthorityName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.typeId.displayable",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.typeId.displayable",
"representation" : [
"xmlAttr"
],
"label" : "Displayable",
"definition" : "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.displayable",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.typeId.root",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.typeId.root",
"representation" : [
"xmlAttr"
],
"label" : "Root",
"definition" : "Identifies the type as an HL7 Registered model",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.root",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/oid",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
],
"fixedString" : "2.16.840.1.113883.1.3"
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.typeId.extension",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.typeId.extension",
"representation" : [
"xmlAttr"
],
"label" : "Extension",
"definition" : "A character string as a unique identifier within the scope of the identifier root.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.extension",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.templateId",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "InfrastructureRoot.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.classCode",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.classCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "EncompassingEncounter.classCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "ENC",
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAActClass"
}
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.moodCode",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.moodCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "EncompassingEncounter.moodCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "EVN",
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAActMood"
}
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.id",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.id",
"comment" : "This encompassingEncounter SHALL contain at least one [1..*] id (CONF:4537-9959).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "EncompassingEncounter.id",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.code",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.code",
"comment" : "This encompassingEncounter MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Act Encounter Codes urn:oid:2.16.840.1.113762.1.4.1240.5 (CONF:1198-30873).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "EncompassingEncounter.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "preferred",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1240.5"
}
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.effectiveTime",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.effectiveTime",
"short" : "Base for all types and resources",
"definition" : "A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.",
"comment" : "This encompassingEncounter SHALL contain exactly one [1..1] US Realm Date and Time (Interval) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.3) (CONF:4537-9958).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "EncompassingEncounter.effectiveTime",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS",
"profile" : [
"http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTimeInterval"
]
}
],
"constraint" : [
{
"key" : "ivl-ts-center",
"severity" : "error",
"human" : "Center cannot co-exist with low or high",
"expression" : "center.empty() or (low.empty() and high.empty())",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"
},
{
"key" : "ivl-value-shall",
"severity" : "error",
"human" : "If a time interval contains @value, then it shall be precise to at least the day.",
"expression" : "value.exists() implies value.toString().length() >= 10",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTimeInterval"
},
{
"key" : "ivl-value-should",
"severity" : "warning",
"human" : "If a time interval contains @value, then it SHOULD contain a time component.",
"expression" : "value.exists() implies value.toString().length() > 10",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTimeInterval"
}
],
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.sdtcAdmissionReferralSourceCode",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString" : "admissionReferralSourceCode"
}
],
"path" : "ClinicalDocument.componentOf.encompassingEncounter.sdtcAdmissionReferralSourceCode",
"definition" : "This element is a coded concept that represents the type of referral. Its RIM source class is PatientEncounter.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "EncompassingEncounter.sdtcAdmissionReferralSourceCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
]
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.dischargeDispositionCode",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.dischargeDispositionCode",
"min" : 0,
"max" : "1",
"base" : {
"path" : "EncompassingEncounter.dischargeDispositionCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "example",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-USEncounterDischargeDisposition"
}
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty",
"definition" : "The responsibleParty participant represents the participant having primary legal responsibility for the encounter. This differs from the legalAuthenticator participant in that the legalAuthenticator may or may not be the responsible party, and is serving a medical records function by signing off on the document, moving it into a completed state.",
"comment" : "This encompassingEncounter SHOULD contain zero or one [0..1] responsibleParty (CONF:1198-8391).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "EncompassingEncounter.responsibleParty",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
}
]
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.nullFlavor",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.realmCode",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.realmCode",
"definition" : "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "InfrastructureRoot.realmCode",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
]
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeId",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeId",
"definition" : "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "InfrastructureRoot.typeId",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
],
"constraint" : [
{
"key" : "II-1",
"severity" : "error",
"human" : "An II instance must have either a root or an nullFlavor.",
"expression" : "root.exists() or nullFlavor.exists()",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"
}
]
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeId.nullFlavor",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeId.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeId.assigningAuthorityName",
"representation" : [
"xmlAttr"
],
"label" : "Assigning Authority Name",
"definition" : "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.assigningAuthorityName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeId.displayable",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeId.displayable",
"representation" : [
"xmlAttr"
],
"label" : "Displayable",
"definition" : "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.displayable",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeId.root",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeId.root",
"representation" : [
"xmlAttr"
],
"label" : "Root",
"definition" : "Identifies the type as an HL7 Registered model",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.root",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/oid",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
],
"fixedString" : "2.16.840.1.113883.1.3"
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeId.extension",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeId.extension",
"representation" : [
"xmlAttr"
],
"label" : "Extension",
"definition" : "A character string as a unique identifier within the scope of the identifier root.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.extension",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.templateId",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "InfrastructureRoot.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeCode",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "EncompassingEncounter.responsibleParty.typeCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "RESP",
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType"
}
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.assignedEntity",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.assignedEntity",
"comment" : "The responsibleParty, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-32904).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "EncompassingEncounter.responsibleParty.assignedEntity",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity"
}
],
"constraint" : [
{
"key" : "1198-32905",
"severity" : "error",
"human" : "This assignedEntity SHALL contain an assignedPerson or a representedOrganization or both (CONF:1198-32905).",
"expression" : "assignedPerson.exists() or representedOrganization.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
}
]
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.encounterParticipant",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.encounterParticipant",
"min" : 0,
"max" : "*",
"base" : {
"path" : "EncompassingEncounter.encounterParticipant",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/EncounterParticipant"
}
]
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.location",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.location",
"definition" : "The location participant (location class) relates a healthcare facility (HealthCareFacility class) to the encounter to indicate where the encounter took place. The entity playing the role of HealthCareFacility is a place (Place class). The entity scoping the HealthCareFacility role is an organization (Organization class).\n\nThe setting of an encounter (e.g. cardiology clinic, primary care clinic, rehabilitation hospital, skilled nursing facility) can be expressed in HealthCareFacility.code. Note that setting and physical location are not the same. There is a many-to-many relationship between setting and the physical location where care is delivered. Thus, a particular room can provide the location for cardiology clinic one day, and for primary care clinic another day; and cardiology clinic today might be held in one physical location, but in another physical location tomorrow.\n\nWhen the location is an organization, this is indicated by the presence of a scoping Organization, without a playing Place.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "EncompassingEncounter.location",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
}
]
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.location.nullFlavor",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.location.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.location.realmCode",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.location.realmCode",
"definition" : "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "InfrastructureRoot.realmCode",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
]
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.location.typeId",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.location.typeId",
"definition" : "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "InfrastructureRoot.typeId",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
],
"constraint" : [
{
"key" : "II-1",
"severity" : "error",
"human" : "An II instance must have either a root or an nullFlavor.",
"expression" : "root.exists() or nullFlavor.exists()",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"
}
]
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.location.typeId.nullFlavor",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.location.typeId.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.location.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.location.typeId.assigningAuthorityName",
"representation" : [
"xmlAttr"
],
"label" : "Assigning Authority Name",
"definition" : "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.assigningAuthorityName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.location.typeId.displayable",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.location.typeId.displayable",
"representation" : [
"xmlAttr"
],
"label" : "Displayable",
"definition" : "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.displayable",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.location.typeId.root",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.location.typeId.root",
"representation" : [
"xmlAttr"
],
"label" : "Root",
"definition" : "Identifies the type as an HL7 Registered model",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.root",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/oid",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
],
"fixedString" : "2.16.840.1.113883.1.3"
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.location.typeId.extension",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.location.typeId.extension",
"representation" : [
"xmlAttr"
],
"label" : "Extension",
"definition" : "A character string as a unique identifier within the scope of the identifier root.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.extension",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.location.templateId",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.location.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "InfrastructureRoot.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.location.typeCode",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.location.typeCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "EncompassingEncounter.location.typeCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "LOC",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ParticipationTargetLocation"
}
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility",
"min" : 1,
"max" : "1",
"base" : {
"path" : "EncompassingEncounter.location.healthCareFacility",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/HealthCareFacility"
}
]
},
{
"id" : "ClinicalDocument.component",
"path" : "ClinicalDocument.component",
"comment" : "SHALL contain exactly one [1..1] component (CONF:1198-31085).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.component",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Component"
}
]
},
{
"id" : "ClinicalDocument.component.nullFlavor",
"path" : "ClinicalDocument.component.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.component.realmCode",
"path" : "ClinicalDocument.component.realmCode",
"definition" : "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "InfrastructureRoot.realmCode",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
]
},
{
"id" : "ClinicalDocument.component.typeId",
"path" : "ClinicalDocument.component.typeId",
"definition" : "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "InfrastructureRoot.typeId",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
],
"constraint" : [
{
"key" : "II-1",
"severity" : "error",
"human" : "An II instance must have either a root or an nullFlavor.",
"expression" : "root.exists() or nullFlavor.exists()",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
}
]
},
{
"id" : "ClinicalDocument.component.typeId.nullFlavor",
"path" : "ClinicalDocument.component.typeId.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.component.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.component.typeId.assigningAuthorityName",
"representation" : [
"xmlAttr"
],
"label" : "Assigning Authority Name",
"definition" : "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.assigningAuthorityName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.component.typeId.displayable",
"path" : "ClinicalDocument.component.typeId.displayable",
"representation" : [
"xmlAttr"
],
"label" : "Displayable",
"definition" : "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.displayable",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id" : "ClinicalDocument.component.typeId.root",
"path" : "ClinicalDocument.component.typeId.root",
"representation" : [
"xmlAttr"
],
"label" : "Root",
"definition" : "Identifies the type as an HL7 Registered model",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.root",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/oid",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
],
"fixedString" : "2.16.840.1.113883.1.3"
},
{
"id" : "ClinicalDocument.component.typeId.extension",
"path" : "ClinicalDocument.component.typeId.extension",
"representation" : [
"xmlAttr"
],
"label" : "Extension",
"definition" : "A character string as a unique identifier within the scope of the identifier root.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.extension",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.component.templateId",
"path" : "ClinicalDocument.component.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "InfrastructureRoot.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.component.typeCode",
"path" : "ClinicalDocument.component.typeCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Component.typeCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "COMP",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActRelationshipHasComponent"
}
},
{
"id" : "ClinicalDocument.component.contextConductionInd",
"path" : "ClinicalDocument.component.contextConductionInd",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Component.contextConductionInd",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
],
"fixedBoolean" : true
},
{
"id" : "ClinicalDocument.component.nonXMLBody",
"path" : "ClinicalDocument.component.nonXMLBody",
"short" : "An Unstructured Document must include a nonXMLBody component with a single text element. The text element can reference an external file using a reference element, or include unstructured content directly with a mediaType attribute. The nonXMLBody/text element also has a \"compression\" attribute that can be used to indicate that the unstructured content was compressed before being Base64Encoded. At a minimum, a compression value of \"DF\" for the deflate compression algorithm (RFC 1951 [URL:http://www.ietf.org/rfc/rfc1951.txt]) must be supported although it is not required that content be compressed.",
"comment" : "This component SHALL contain exactly one [1..1] nonXMLBody (CONF:1198-31086).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Component.nonXMLBody",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/NonXMLBody"
}
]
},
{
"id" : "ClinicalDocument.component.nonXMLBody.nullFlavor",
"path" : "ClinicalDocument.component.nonXMLBody.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.component.nonXMLBody.realmCode",
"path" : "ClinicalDocument.component.nonXMLBody.realmCode",
"definition" : "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "InfrastructureRoot.realmCode",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
]
},
{
"id" : "ClinicalDocument.component.nonXMLBody.typeId",
"path" : "ClinicalDocument.component.nonXMLBody.typeId",
"definition" : "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "InfrastructureRoot.typeId",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
],
"constraint" : [
{
"key" : "II-1",
"severity" : "error",
"human" : "An II instance must have either a root or an nullFlavor.",
"expression" : "root.exists() or nullFlavor.exists()",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
}
]
},
{
"id" : "ClinicalDocument.component.nonXMLBody.typeId.nullFlavor",
"path" : "ClinicalDocument.component.nonXMLBody.typeId.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.component.nonXMLBody.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.component.nonXMLBody.typeId.assigningAuthorityName",
"representation" : [
"xmlAttr"
],
"label" : "Assigning Authority Name",
"definition" : "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.assigningAuthorityName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.component.nonXMLBody.typeId.displayable",
"path" : "ClinicalDocument.component.nonXMLBody.typeId.displayable",
"representation" : [
"xmlAttr"
],
"label" : "Displayable",
"definition" : "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.displayable",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id" : "ClinicalDocument.component.nonXMLBody.typeId.root",
"path" : "ClinicalDocument.component.nonXMLBody.typeId.root",
"representation" : [
"xmlAttr"
],
"label" : "Root",
"definition" : "Identifies the type as an HL7 Registered model",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.root",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/oid",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
],
"fixedString" : "2.16.840.1.113883.1.3"
},
{
"id" : "ClinicalDocument.component.nonXMLBody.typeId.extension",
"path" : "ClinicalDocument.component.nonXMLBody.typeId.extension",
"representation" : [
"xmlAttr"
],
"label" : "Extension",
"definition" : "A character string as a unique identifier within the scope of the identifier root.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.extension",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.component.nonXMLBody.templateId",
"path" : "ClinicalDocument.component.nonXMLBody.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "InfrastructureRoot.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.component.nonXMLBody.classCode",
"path" : "ClinicalDocument.component.nonXMLBody.classCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "NonXMLBody.classCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "DOCBODY",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActClassRecordOrganizer"
}
},
{
"id" : "ClinicalDocument.component.nonXMLBody.moodCode",
"path" : "ClinicalDocument.component.nonXMLBody.moodCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "NonXMLBody.moodCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "EVN",
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAActMood"
}
},
{
"id" : "ClinicalDocument.component.nonXMLBody.text",
"path" : "ClinicalDocument.component.nonXMLBody.text",
"comment" : "This nonXMLBody SHALL contain exactly one [1..1] text (CONF:1198-31087).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "NonXMLBody.text",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ED"
}
],
"constraint" : [
{
"key" : "1198-7624",
"severity" : "error",
"human" : "If the text element does not contain a reference element with a value attribute, then it **SHALL** contain exactly one [1..1] @representation=\"B64\" and exactly one [1..1] @mediaType (CONF:1198-7624).",
"expression" : "reference.value.empty() implies (representation = 'B64' and mediaType.exists())",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/UnstructuredDocument"
}
]
},
{
"id" : "ClinicalDocument.component.nonXMLBody.text.nullFlavor",
"path" : "ClinicalDocument.component.nonXMLBody.text.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "ClinicalDocument.component.nonXMLBody.text.compression",
"path" : "ClinicalDocument.component.nonXMLBody.text.compression",
"representation" : [
"xmlAttr"
],
"label" : "Compression",
"definition" : "Indicates whether the raw byte data is compressed, and what compression algorithm was used.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ED.compression",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm"
}
},
{
"id" : "ClinicalDocument.component.nonXMLBody.text.integrityCheck",
"path" : "ClinicalDocument.component.nonXMLBody.text.integrityCheck",
"representation" : [
"xmlAttr"
],
"label" : "Integrity Check",
"definition" : "The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ED.integrityCheck",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "base64Binary",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/bin"
]
}
]
},
{
"id" : "ClinicalDocument.component.nonXMLBody.text.integrityCheckAlgorithm",
"path" : "ClinicalDocument.component.nonXMLBody.text.integrityCheckAlgorithm",
"representation" : [
"xmlAttr"
],
"label" : "Integrity Check Algorithm",
"definition" : "Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ED.integrityCheckAlgorithm",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0"
}
},
{
"id" : "ClinicalDocument.component.nonXMLBody.text.language",
"path" : "ClinicalDocument.component.nonXMLBody.text.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ED.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.component.nonXMLBody.text.mediaType",
"path" : "ClinicalDocument.component.nonXMLBody.text.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ED.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.7.1"
}
},
{
"id" : "ClinicalDocument.component.nonXMLBody.text.representation",
"path" : "ClinicalDocument.component.nonXMLBody.text.representation",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "ED.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding"
}
},
{
"id" : "ClinicalDocument.component.nonXMLBody.text.xmlText",
"path" : "ClinicalDocument.component.nonXMLBody.text.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.",
"definition" : "Data that is primarily intended for human interpretation or for further machine processing is outside the scope of HL7. This includes unformatted or formatted written language, multimedia data, or structured information as defined by a different standard (e.g., XML-signatures.)",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ED.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.component.nonXMLBody.text.reference",
"path" : "ClinicalDocument.component.nonXMLBody.text.reference",
"label" : "Reference",
"definition" : "A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ED.reference",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/TEL"
}
]
},
{
"id" : "ClinicalDocument.component.nonXMLBody.text.thumbnail",
"path" : "ClinicalDocument.component.nonXMLBody.text.thumbnail",
"label" : "Thumbnail",
"definition" : "An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ED.thumbnail",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ED"
}
]
},
{
"id" : "ClinicalDocument.component.nonXMLBody.confidentialityCode",
"path" : "ClinicalDocument.component.nonXMLBody.confidentialityCode",
"min" : 0,
"max" : "1",
"base" : {
"path" : "NonXMLBody.confidentialityCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
]
},
{
"id" : "ClinicalDocument.component.nonXMLBody.languageCode",
"path" : "ClinicalDocument.component.nonXMLBody.languageCode",
"min" : 0,
"max" : "1",
"base" : {
"path" : "NonXMLBody.languageCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/fhir/ValueSet/all-languages"
}
},
{
"id" : "ClinicalDocument.component.structuredBody",
"path" : "ClinicalDocument.component.structuredBody",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Component.structuredBody",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/StructuredBody"
}
]
}
]
},
"differential" : {
"element" : [
{
"id" : "ClinicalDocument",
"path" : "ClinicalDocument"
},
{
"id" : "ClinicalDocument.templateId",
"path" : "ClinicalDocument.templateId",
"min" : 2
},
{
"id" : "ClinicalDocument.templateId:unstructured-doc",
"path" : "ClinicalDocument.templateId",
"sliceName" : "unstructured-doc",
"min" : 1,
"max" : "1"
},
{
"id" : "ClinicalDocument.templateId:unstructured-doc.root",
"path" : "ClinicalDocument.templateId.root",
"min" : 1,
"patternString" : "2.16.840.1.113883.10.20.22.1.10"
},
{
"id" : "ClinicalDocument.templateId:unstructured-doc.extension",
"path" : "ClinicalDocument.templateId.extension",
"min" : 1,
"patternString" : "2024-05-01"
},
{
"id" : "ClinicalDocument.recordTarget",
"path" : "ClinicalDocument.recordTarget",
"comment" : "SHALL contain at least one [1..*] recordTarget (CONF:1198-31089)."
},
{
"id" : "ClinicalDocument.recordTarget.patientRole",
"path" : "ClinicalDocument.recordTarget.patientRole",
"comment" : "Such recordTargets SHALL contain exactly one [1..1] patientRole (CONF:1198-31090)."
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.id",
"path" : "ClinicalDocument.recordTarget.patientRole.id",
"comment" : "This patientRole SHALL contain at least one [1..*] id (CONF:1198-31091)."
},
{
"id" : "ClinicalDocument.custodian",
"path" : "ClinicalDocument.custodian",
"comment" : "SHALL contain exactly one [1..1] custodian (CONF:1198-31096)."
},
{
"id" : "ClinicalDocument.custodian.assignedCustodian",
"path" : "ClinicalDocument.custodian.assignedCustodian",
"comment" : "This custodian SHALL contain exactly one [1..1] assignedCustodian (CONF:1198-31097)."
},
{
"id" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization",
"path" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization",
"comment" : "This assignedCustodian SHALL contain exactly one [1..1] representedCustodianOrganization (CONF:1198-31098)."
},
{
"id" : "ClinicalDocument.component",
"path" : "ClinicalDocument.component",
"comment" : "SHALL contain exactly one [1..1] component (CONF:1198-31085)."
},
{
"id" : "ClinicalDocument.component.nonXMLBody",
"path" : "ClinicalDocument.component.nonXMLBody",
"short" : "An Unstructured Document must include a nonXMLBody component with a single text element. The text element can reference an external file using a reference element, or include unstructured content directly with a mediaType attribute. The nonXMLBody/text element also has a \"compression\" attribute that can be used to indicate that the unstructured content was compressed before being Base64Encoded. At a minimum, a compression value of \"DF\" for the deflate compression algorithm (RFC 1951 [URL:http://www.ietf.org/rfc/rfc1951.txt]) must be supported although it is not required that content be compressed.",
"comment" : "This component SHALL contain exactly one [1..1] nonXMLBody (CONF:1198-31086).",
"min" : 1
},
{
"id" : "ClinicalDocument.component.nonXMLBody.text",
"path" : "ClinicalDocument.component.nonXMLBody.text",
"comment" : "This nonXMLBody SHALL contain exactly one [1..1] text (CONF:1198-31087).",
"constraint" : [
{
"key" : "1198-7624",
"severity" : "error",
"human" : "If the text element does not contain a reference element with a value attribute, then it **SHALL** contain exactly one [1..1] @representation=\"B64\" and exactly one [1..1] @mediaType (CONF:1198-7624).",
"expression" : "reference.value.empty() implies (representation = 'B64' and mediaType.exists())",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/UnstructuredDocument"
}
]
},
{
"id" : "ClinicalDocument.component.nonXMLBody.text.mediaType",
"path" : "ClinicalDocument.component.nonXMLBody.text.mediaType",
"binding" : {
"strength" : "required",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.7.1"
}
}
]
}
}
XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.